Class Step
- java.lang.Object
-
- software.amazon.awssdk.services.amplify.model.Step
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<Step.Builder,Step>
@Generated("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 Description static interfaceStep.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringartifactsUrl()The URL to the artifact for the execution step.static Step.Builderbuilder()Stringcontext()The context for the current step.InstantendTime()The end date and time of the execution step.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasScreenshots()For responses, this returns true if the service returned a value for the Screenshots property.StringlogUrl()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()InstantstartTime()The start date and time of the execution step.JobStatusstatus()The status of the execution step.StringstatusAsString()The status of the execution step.StringstatusReason()The reason for the current step status.StringstepName()The name of the execution step.StringtestArtifactsUrl()The URL to the test artifact for the execution step.StringtestConfigUrl()The URL to the test configuration for the execution step.Step.BuildertoBuilder()StringtoString()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 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,
statuswill returnJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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,
statuswill returnJobStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- 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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<Step.Builder,Step>
-
builder
public static Step.Builder builder()
-
serializableBuilderClass
public static Class<? extends Step.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-