Class ListedExecution

java.lang.Object
software.amazon.awssdk.services.transfer.model.ListedExecution
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ListedExecution.Builder,ListedExecution>

@Generated("software.amazon.awssdk:codegen") public final class ListedExecution extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ListedExecution.Builder,ListedExecution>

Returns properties of the execution that is specified.

See Also:
  • Method Details

    • executionId

      public final String executionId()

      A unique identifier for the execution of a workflow.

      Returns:
      A unique identifier for the execution of a workflow.
    • initialFileLocation

      public final FileLocation initialFileLocation()

      A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.

      Returns:
      A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
    • serviceMetadata

      public final ServiceMetadata serviceMetadata()

      A container object for the session details that are associated with a workflow.

      Returns:
      A container object for the session details that are associated with a workflow.
    • status

      public final ExecutionStatus status()

      The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

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

      Returns:
      The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.

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

      Returns:
      The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
      See Also:
    • toBuilder

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

      public static ListedExecution.Builder builder()
    • serializableBuilderClass

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