Package software.amazon.awssdk.services.transfer.model

Class DescribedExecution

java.lang.Object

software.amazon.awssdk.services.transfer.model.DescribedExecution

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DescribedExecution.Builder,DescribedExecution>

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

The details for an execution object.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribedExecution.Builder

Method Summary

Modifier and Type	Method	Description
static DescribedExecution.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionId()	A unique identifier for the execution of a workflow.
String	executionRole()	The IAM role associated with the execution.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
FileLocation	initialFileLocation()	A structure that describes the Amazon S3 or EFS file location.
LoggingConfiguration	loggingConfiguration()	The IAM logging role associated with the execution.
PosixProfile	posixProfile()	Returns the value of the PosixProfile property for this object.
ExecutionResults	results()	A structure that describes the execution results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DescribedExecution.Builder>	serializableBuilderClass()
ServiceMetadata	serviceMetadata()	A container object for the session details that are associated with a workflow.
ExecutionStatus	status()	The status is one of the execution.
String	statusAsString()	The status is one of the execution.
DescribedExecution.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

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.

executionRole

public final String executionRole()

The IAM role associated with the execution.

Returns:

The IAM role associated with the execution.

loggingConfiguration

public final LoggingConfiguration loggingConfiguration()

The IAM logging role associated with the execution.

Returns:

The IAM logging role associated with the execution.

posixProfile

public final PosixProfile posixProfile()

Returns the value of the PosixProfile property for this object.

Returns:

The value of the PosixProfile property for this object.

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:

ExecutionStatus

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:

ExecutionStatus

results

public final ExecutionResults results()

A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

Returns:

A structure that describes the execution results. This includes a list of the steps along with the details of each step, error type and message (if any), and the OnExceptionSteps structure.

toBuilder

public DescribedExecution.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribedExecution.Builder,DescribedExecution>

builder

public static DescribedExecution.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo