DescribedExecution (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.DescribedExecution

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedExecution
extends Object
implements Serializable, Cloneable, StructuredPojo

The details for an execution object.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedExecution()

Constructors
Constructor and Description
`DescribedExecution()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedExecution`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getExecutionId()` A unique identifier for the execution of a workflow.
`String`	`getExecutionRole()` The IAM role associated with the execution.
`FileLocation`	`getInitialFileLocation()` A structure that describes the Amazon S3 or EFS file location.
`LoggingConfiguration`	`getLoggingConfiguration()` The IAM logging role associated with the execution.
`PosixProfile`	`getPosixProfile()`
`ExecutionResults`	`getResults()` A structure that describes the execution results.
`ServiceMetadata`	`getServiceMetadata()` A container object for the session details that are associated with a workflow.
`String`	`getStatus()` The status is one of the execution.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setExecutionId(String executionId)` A unique identifier for the execution of a workflow.
`void`	`setExecutionRole(String executionRole)` The IAM role associated with the execution.
`void`	`setInitialFileLocation(FileLocation initialFileLocation)` A structure that describes the Amazon S3 or EFS file location.
`void`	`setLoggingConfiguration(LoggingConfiguration loggingConfiguration)` The IAM logging role associated with the execution.
`void`	`setPosixProfile(PosixProfile posixProfile)`
`void`	`setResults(ExecutionResults results)` A structure that describes the execution results.
`void`	`setServiceMetadata(ServiceMetadata serviceMetadata)` A container object for the session details that are associated with a workflow.
`void`	`setStatus(String status)` The status is one of the execution.
`String`	`toString()` Returns a string representation of this object.
`DescribedExecution`	`withExecutionId(String executionId)` A unique identifier for the execution of a workflow.
`DescribedExecution`	`withExecutionRole(String executionRole)` The IAM role associated with the execution.
`DescribedExecution`	`withInitialFileLocation(FileLocation initialFileLocation)` A structure that describes the Amazon S3 or EFS file location.
`DescribedExecution`	`withLoggingConfiguration(LoggingConfiguration loggingConfiguration)` The IAM logging role associated with the execution.
`DescribedExecution`	`withPosixProfile(PosixProfile posixProfile)`
`DescribedExecution`	`withResults(ExecutionResults results)` A structure that describes the execution results.
`DescribedExecution`	`withServiceMetadata(ServiceMetadata serviceMetadata)` A container object for the session details that are associated with a workflow.
`DescribedExecution`	`withStatus(ExecutionStatus status)` The status is one of the execution.
`DescribedExecution`	`withStatus(String status)` The status is one of the execution.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedExecution
```
public DescribedExecution()
```
- Method Detail
  - setExecutionId
```
public void setExecutionId(String executionId)
```
    A unique identifier for the execution of a workflow.
    
    Parameters:
    
    executionId - A unique identifier for the execution of a workflow.
  - getExecutionId
```
public String getExecutionId()
```
    A unique identifier for the execution of a workflow.
    
    Returns:
    
    A unique identifier for the execution of a workflow.
  - withExecutionId
```
public DescribedExecution withExecutionId(String executionId)
```
    A unique identifier for the execution of a workflow.
    
    Parameters:
    
    executionId - A unique identifier for the execution of a workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInitialFileLocation
```
public void setInitialFileLocation(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.
    
    Parameters:
    
    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.
  - getInitialFileLocation
```
public FileLocation getInitialFileLocation()
```
    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.
  - withInitialFileLocation
```
public DescribedExecution withInitialFileLocation(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceMetadata
```
public void setServiceMetadata(ServiceMetadata serviceMetadata)
```
    A container object for the session details that are associated with a workflow.
    
    Parameters:
    
    serviceMetadata - A container object for the session details that are associated with a workflow.
  - getServiceMetadata
```
public ServiceMetadata getServiceMetadata()
```
    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.
  - withServiceMetadata
```
public DescribedExecution withServiceMetadata(ServiceMetadata serviceMetadata)
```
    A container object for the session details that are associated with a workflow.
    
    Parameters:
    
    serviceMetadata - A container object for the session details that are associated with a workflow.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionRole
```
public void setExecutionRole(String executionRole)
```
    The IAM role associated with the execution.
    
    Parameters:
    
    executionRole - The IAM role associated with the execution.
  - getExecutionRole
```
public String getExecutionRole()
```
    The IAM role associated with the execution.
    
    Returns:
    
    The IAM role associated with the execution.
  - withExecutionRole
```
public DescribedExecution withExecutionRole(String executionRole)
```
    The IAM role associated with the execution.
    
    Parameters:
    
    executionRole - The IAM role associated with the execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLoggingConfiguration
```
public void setLoggingConfiguration(LoggingConfiguration loggingConfiguration)
```
    The IAM logging role associated with the execution.
    
    Parameters:
    
    loggingConfiguration - The IAM logging role associated with the execution.
  - getLoggingConfiguration
```
public LoggingConfiguration getLoggingConfiguration()
```
    The IAM logging role associated with the execution.
    
    Returns:
    
    The IAM logging role associated with the execution.
  - withLoggingConfiguration
```
public DescribedExecution withLoggingConfiguration(LoggingConfiguration loggingConfiguration)
```
    The IAM logging role associated with the execution.
    
    Parameters:
    
    loggingConfiguration - The IAM logging role associated with the execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPosixProfile
```
public void setPosixProfile(PosixProfile posixProfile)
```
    Parameters:
    
    posixProfile -
  - getPosixProfile
```
public PosixProfile getPosixProfile()
```
    Returns:
  - withPosixProfile
```
public DescribedExecution withPosixProfile(PosixProfile posixProfile)
```
    Parameters:
    
    posixProfile -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    Parameters:
    
    status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    See Also:
    
    ExecutionStatus
  - getStatus
```
public String getStatus()
```
    The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    Returns:
    
    The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    See Also:
    
    ExecutionStatus
  - withStatus
```
public DescribedExecution withStatus(String status)
```
    The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    Parameters:
    
    status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExecutionStatus
  - withStatus
```
public DescribedExecution withStatus(ExecutionStatus status)
```
    The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    Parameters:
    
    status - The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ExecutionStatus
  - setResults
```
public void setResults(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.
    
    Parameters:
    
    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.
  - getResults
```
public ExecutionResults getResults()
```
    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.
  - withResults
```
public DescribedExecution withResults(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribedExecution clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class DescribedExecution

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedExecution

Method Detail

setExecutionId

getExecutionId

withExecutionId

setInitialFileLocation

getInitialFileLocation

withInitialFileLocation

setServiceMetadata

getServiceMetadata

withServiceMetadata

setExecutionRole

getExecutionRole

withExecutionRole

setLoggingConfiguration

getLoggingConfiguration

withLoggingConfiguration

setPosixProfile

getPosixProfile

withPosixProfile

setStatus

getStatus

withStatus

withStatus

setResults

getResults

withResults

toString

equals

hashCode

clone

marshall