Step (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.amplify.model.Step

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Step.Builder,Step>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Step
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Step.Builder,Step>
```
Describes an execution step, for an execution job, for an Amplify app.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Step.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Step.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`artifactsUrl()` The URL to the artifact for the execution step.
`static Step.Builder`	`builder()`
`String`	`context()` The context for the current step.
`Instant`	`endTime()` The end date and time of the execution step.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasScreenshots()` For responses, this returns true if the service returned a value for the Screenshots property.
`String`	`logUrl()` The URL to the logs for the execution step.
`Map<String,String>`	`screenshots()` The list of screenshot URLs for the execution step, if relevant.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Step.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The start date and time of the execution step.
`JobStatus`	`status()` The status of the execution step.
`String`	`statusAsString()` The status of the execution step.
`String`	`statusReason()` The reason for the current step status.
`String`	`stepName()` The name of the execution step.
`String`	`testArtifactsUrl()` The URL to the test artifact for the execution step.
`String`	`testConfigUrl()` The URL to the test configuration for the execution step.
`Step.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - stepName
```
public final String stepName()
```
    The name of the execution step.
    
    Returns:
    
    The name of the execution step.
  - startTime
```
public final Instant startTime()
```
    The start date and time of the execution step.
    
    Returns:
    
    The start date and time of the execution step.
  - status
```
public final JobStatus status()
```
    The status of the execution step.
    
    If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the execution step.
    
    See Also:
    
    JobStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the execution step.
    
    If the service returns an enum value that is not available in the current SDK version, status will return JobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the execution step.
    
    See Also:
    
    JobStatus
  - endTime
```
public final Instant endTime()
```
    The end date and time of the execution step.
    
    Returns:
    
    The end date and time of the execution step.
  - logUrl
```
public final String logUrl()
```
    The URL to the logs for the execution step.
    
    Returns:
    
    The URL to the logs for the execution step.
  - artifactsUrl
```
public final String artifactsUrl()
```
    The URL to the artifact for the execution step.
    
    Returns:
    
    The URL to the artifact for the execution step.
  - testArtifactsUrl
```
public final String testArtifactsUrl()
```
    The URL to the test artifact for the execution step.
    
    Returns:
    
    The URL to the test artifact for the execution step.
  - testConfigUrl
```
public final String testConfigUrl()
```
    The URL to the test configuration for the execution step.
    
    Returns:
    
    The URL to the test configuration for the execution step.
  - hasScreenshots
```
public final boolean hasScreenshots()
```
    For responses, this returns true if the service returned a value for the Screenshots property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - screenshots
```
public final Map<String,String> screenshots()
```
    The list of screenshot URLs for the execution step, if relevant.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScreenshots() method.
    
    Returns:
    
    The list of screenshot URLs for the execution step, if relevant.
  - statusReason
```
public final String statusReason()
```
    The reason for the current step status.
    
    Returns:
    
    The reason for the current step status.
  - context
```
public final String context()
```
    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.
  - toBuilder
```
public Step.Builder 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 interface ToCopyableBuilder<Step.Builder,Step>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Step.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Step.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.42

Class Step

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

stepName

startTime

status

statusAsString

endTime

logUrl

artifactsUrl

testArtifactsUrl

testConfigUrl

hasScreenshots

screenshots

statusReason

context

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields