Class ExecutionStepResult

java.lang.Object
software.amazon.awssdk.services.transfer.model.ExecutionStepResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExecutionStepResult.Builder,ExecutionStepResult>
@Generated("software.amazon.awssdk:codegen") public final class ExecutionStepResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExecutionStepResult.Builder,ExecutionStepResult>

Specifies the following details for the step: error (if any), outputs (if any), and the step type.

See Also:

  • Method Details

    • stepType

      public final WorkflowStepType stepType()

      One of the available step types.

      • COPY - Copy the file to another location.

      • CUSTOM - Perform a custom step with an Lambda function target.

      • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

      • DELETE - Delete the file.

      • TAG - Add a tag to the file.

      If the service returns an enum value that is not available in the current SDK version, stepType will return WorkflowStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepTypeAsString().

      Returns:
      One of the available step types.

      • COPY - Copy the file to another location.

      • CUSTOM - Perform a custom step with an Lambda function target.

      • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

      • DELETE - Delete the file.

      • TAG - Add a tag to the file.

      See Also:

    • stepTypeAsString

      public final String stepTypeAsString()

      One of the available step types.

      • COPY - Copy the file to another location.

      • CUSTOM - Perform a custom step with an Lambda function target.

      • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

      • DELETE - Delete the file.

      • TAG - Add a tag to the file.

      If the service returns an enum value that is not available in the current SDK version, stepType will return WorkflowStepType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepTypeAsString().

      Returns:
      One of the available step types.

      • COPY - Copy the file to another location.

      • CUSTOM - Perform a custom step with an Lambda function target.

      • DECRYPT - Decrypt a file that was encrypted before it was uploaded.

      • DELETE - Delete the file.

      • TAG - Add a tag to the file.

      See Also:

    • outputs

      public final String outputs()

      The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

      Returns:
      The values for the key/value pair applied as a tag to the file. Only applicable if the step type is TAG.

    • error

      public final ExecutionError error()

      Specifies the details for an error, if it occurred during execution of the specified workflow step.

      Returns:
      Specifies the details for an error, if it occurred during execution of the specified workflow step.

    • toBuilder

      public ExecutionStepResult.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<ExecutionStepResult.Builder,ExecutionStepResult>
      Returns:
      a builder for type T

    • builder

      public static ExecutionStepResult.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExecutionStepResult.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.