Class ListWorkflowStepExecutionsResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.imagebuilder.model.ImagebuilderResponse
software.amazon.awssdk.services.imagebuilder.model.ListWorkflowStepExecutionsResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListWorkflowStepExecutionsResponse.Builder,ListWorkflowStepExecutionsResponse>
@Generated("software.amazon.awssdk:codegen") public final class ListWorkflowStepExecutionsResponse extends ImagebuilderResponse implements ToCopyableBuilder<ListWorkflowStepExecutionsResponse.Builder,ListWorkflowStepExecutionsResponse>

  • Method Details

    • requestId

      public final String requestId()

      The request ID that uniquely identifies this request.

      Returns:
      The request ID that uniquely identifies this request.

    • hasSteps

      public final boolean hasSteps()
      For responses, this returns true if the service returned a value for the Steps 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.

    • steps

      public final List<WorkflowStepMetadata> steps()

      Contains an array of runtime details that represents each step in this runtime instance of the workflow.

      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 hasSteps() method.

      Returns:
      Contains an array of runtime details that represents each step in this runtime instance of the workflow.

    • workflowBuildVersionArn

      public final String workflowBuildVersionArn()

      The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.

      Returns:
      The build version ARN for the Image Builder workflow resource that defines the steps for this runtime instance of the workflow.

    • workflowExecutionId

      public final String workflowExecutionId()

      The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

      Returns:
      The unique identifier that Image Builder assigned to keep track of runtime details when it ran the workflow.

    • imageBuildVersionArn

      public final String imageBuildVersionArn()

      The image build version resource ARN that's associated with the specified runtime instance of the workflow.

      Returns:
      The image build version resource ARN that's associated with the specified runtime instance of the workflow.

    • message

      public final String message()

      The output message from the list action, if applicable.

      Returns:
      The output message from the list action, if applicable.

    • nextToken

      public final String nextToken()

      The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

      Returns:
      The next token used for paginated responses. When this field isn't empty, there are additional elements that the service hasn't included in this request. Use this token with the next request to retrieve additional objects.

    • toBuilder

      public ListWorkflowStepExecutionsResponse.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<ListWorkflowStepExecutionsResponse.Builder,ListWorkflowStepExecutionsResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static ListWorkflowStepExecutionsResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.