software.amazon.awssdk.services.amplify.model

Class Step

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>

Structure for 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

Method Summary

Modifier and Type	Method and Description
String	artifactsUrl() URL to the artifact for the execution step.
static Step.Builder	builder()
String	context() The context for current step, will include build image if step is build.
Instant	endTime() End date/ time of the execution step.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasScreenshots() Returns true if the Screenshots property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	logUrl() URL to the logs for the execution step.
Map<String,String>	screenshots() List of screenshot URLs for the execution step, if relevant.
List<SdkField<?>>	sdkFields()
static Class<? extends Step.Builder>	serializableBuilderClass()
Instant	startTime() Start date/ time of the execution step.
JobStatus	status() Status of the execution step.
String	statusAsString() Status of the execution step.
String	statusReason() The reason for current step status.
String	stepName() Name of the execution step.
String	testArtifactsUrl() URL to the test artifact for the execution step.
String	testConfigUrl() URL to the test config for the execution step.
Step.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

stepName

public String stepName()

Name of the execution step.

Returns:

Name of the execution step.

startTime

public Instant startTime()

Start date/ time of the execution step.

Returns:

Start date/ time of the execution step.

status

public JobStatus status()

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:

Status of the execution step.

See Also:

JobStatus

statusAsString

public String statusAsString()

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:

Status of the execution step.

See Also:

JobStatus

endTime

public Instant endTime()

End date/ time of the execution step.

Returns:

End date/ time of the execution step.

logUrl

public String logUrl()

URL to the logs for the execution step.

Returns:

URL to the logs for the execution step.

artifactsUrl

public String artifactsUrl()

URL to the artifact for the execution step.

Returns:

URL to the artifact for the execution step.

testArtifactsUrl

public String testArtifactsUrl()

URL to the test artifact for the execution step.

Returns:

URL to the test artifact for the execution step.

testConfigUrl

public String testConfigUrl()

URL to the test config for the execution step.

Returns:

URL to the test config for the execution step.

hasScreenshots

public boolean hasScreenshots()

Returns true if the Screenshots property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

screenshots

public Map<String,String> screenshots()

List of screenshot URLs for the execution step, if relevant.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasScreenshots() to see if a value was sent in this field.

Returns:

List of screenshot URLs for the execution step, if relevant.

statusReason

public String statusReason()

The reason for current step status.

Returns:

The reason for current step status.

context

public String context()

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.

toBuilder

public Step.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Step.Builder,Step>

builder

public static Step.Builder builder()

serializableBuilderClass

public static Class<? extends Step.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo