GetCapacityTaskResult (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.outposts.model

Class GetCapacityTaskResult

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.outposts.model.GetCapacityTaskResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetCapacityTaskResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetCapacityTaskResult ()

Constructors
Constructor and Description
`GetCapacityTaskResult ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`GetCapacityTaskResult`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getCapacityTaskId ()` ID of the capacity task.
`String`	`getCapacityTaskStatus ()` Status of the capacity task.
`Date`	`getCompletionDate ()` The date the capacity task ran successfully.
`Date`	`getCreationDate ()` The date the capacity task was created.
`Boolean`	`getDryRun ()` Performs a dry run to determine if you are above or below instance capacity.
`CapacityTaskFailure`	`getFailed ()` Reason why the capacity task failed.
`Date`	`getLastModifiedDate ()` The date the capacity task was last modified.
`String`	`getOrderId ()` ID of the Amazon Web Services Outposts order associated with the specified capacity task.
`String`	`getOutpostId ()` ID of the Outpost associated with the specified capacity task.
`List<InstanceTypeCapacity>`	`getRequestedInstancePools ()` List of instance pools requested in the capacity task.
`int`	`hashCode ()`
`Boolean`	`isDryRun ()` Performs a dry run to determine if you are above or below instance capacity.
`void`	`setCapacityTaskId (String capacityTaskId)` ID of the capacity task.
`void`	`setCapacityTaskStatus (String capacityTaskStatus)` Status of the capacity task.
`void`	`setCompletionDate (Date completionDate)` The date the capacity task ran successfully.
`void`	`setCreationDate (Date creationDate)` The date the capacity task was created.
`void`	`setDryRun (Boolean dryRun)` Performs a dry run to determine if you are above or below instance capacity.
`void`	`setFailed (CapacityTaskFailure failed)` Reason why the capacity task failed.
`void`	`setLastModifiedDate (Date lastModifiedDate)` The date the capacity task was last modified.
`void`	`setOrderId (String orderId)` ID of the Amazon Web Services Outposts order associated with the specified capacity task.
`void`	`setOutpostId (String outpostId)` ID of the Outpost associated with the specified capacity task.
`void`	`setRequestedInstancePools (Collection<InstanceTypeCapacity> requestedInstancePools)` List of instance pools requested in the capacity task.
`String`	`toString ()` Returns a string representation of this object.
`GetCapacityTaskResult`	`withCapacityTaskId (String capacityTaskId)` ID of the capacity task.
`GetCapacityTaskResult`	`withCapacityTaskStatus (CapacityTaskStatus capacityTaskStatus)` Status of the capacity task.
`GetCapacityTaskResult`	`withCapacityTaskStatus (String capacityTaskStatus)` Status of the capacity task.
`GetCapacityTaskResult`	`withCompletionDate (Date completionDate)` The date the capacity task ran successfully.
`GetCapacityTaskResult`	`withCreationDate (Date creationDate)` The date the capacity task was created.
`GetCapacityTaskResult`	`withDryRun (Boolean dryRun)` Performs a dry run to determine if you are above or below instance capacity.
`GetCapacityTaskResult`	`withFailed (CapacityTaskFailure failed)` Reason why the capacity task failed.
`GetCapacityTaskResult`	`withLastModifiedDate (Date lastModifiedDate)` The date the capacity task was last modified.
`GetCapacityTaskResult`	`withOrderId (String orderId)` ID of the Amazon Web Services Outposts order associated with the specified capacity task.
`GetCapacityTaskResult`	`withOutpostId (String outpostId)` ID of the Outpost associated with the specified capacity task.
`GetCapacityTaskResult`	`withRequestedInstancePools (Collection<InstanceTypeCapacity> requestedInstancePools)` List of instance pools requested in the capacity task.
`GetCapacityTaskResult`	`withRequestedInstancePools (InstanceTypeCapacity... requestedInstancePools)` List of instance pools requested in the capacity task.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetCapacityTaskResult
```
public GetCapacityTaskResult()
```
- Method Detail
  - setCapacityTaskId
```
public void setCapacityTaskId(String capacityTaskId)
```
    ID of the capacity task.
    
    Parameters:
    
    capacityTaskId - ID of the capacity task.
  - getCapacityTaskId
```
public String getCapacityTaskId()
```
    ID of the capacity task.
    
    Returns:
    
    ID of the capacity task.
  - withCapacityTaskId
```
public GetCapacityTaskResult withCapacityTaskId(String capacityTaskId)
```
    ID of the capacity task.
    
    Parameters:
    
    capacityTaskId - ID of the capacity task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutpostId
```
public void setOutpostId(String outpostId)
```
    ID of the Outpost associated with the specified capacity task.
    
    Parameters:
    
    outpostId - ID of the Outpost associated with the specified capacity task.
  - getOutpostId
```
public String getOutpostId()
```
    ID of the Outpost associated with the specified capacity task.
    
    Returns:
    
    ID of the Outpost associated with the specified capacity task.
  - withOutpostId
```
public GetCapacityTaskResult withOutpostId(String outpostId)
```
    ID of the Outpost associated with the specified capacity task.
    
    Parameters:
    
    outpostId - ID of the Outpost associated with the specified capacity task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOrderId
```
public void setOrderId(String orderId)
```
    ID of the Amazon Web Services Outposts order associated with the specified capacity task.
    
    Parameters:
    
    orderId - ID of the Amazon Web Services Outposts order associated with the specified capacity task.
  - getOrderId
```
public String getOrderId()
```
    ID of the Amazon Web Services Outposts order associated with the specified capacity task.
    
    Returns:
    
    ID of the Amazon Web Services Outposts order associated with the specified capacity task.
  - withOrderId
```
public GetCapacityTaskResult withOrderId(String orderId)
```
    ID of the Amazon Web Services Outposts order associated with the specified capacity task.
    
    Parameters:
    
    orderId - ID of the Amazon Web Services Outposts order associated with the specified capacity task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequestedInstancePools
```
public List<InstanceTypeCapacity> getRequestedInstancePools()
```
    List of instance pools requested in the capacity task.
    
    Returns:
    
    List of instance pools requested in the capacity task.
  - setRequestedInstancePools
```
public void setRequestedInstancePools(Collection<InstanceTypeCapacity> requestedInstancePools)
```
    List of instance pools requested in the capacity task.
    
    Parameters:
    
    requestedInstancePools - List of instance pools requested in the capacity task.
  - withRequestedInstancePools
```
public GetCapacityTaskResult withRequestedInstancePools(InstanceTypeCapacity... requestedInstancePools)
```
    List of instance pools requested in the capacity task.
    
    NOTE: This method appends the values to the existing list (if any). Use setRequestedInstancePools(java.util.Collection) or withRequestedInstancePools(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    requestedInstancePools - List of instance pools requested in the capacity task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRequestedInstancePools
```
public GetCapacityTaskResult withRequestedInstancePools(Collection<InstanceTypeCapacity> requestedInstancePools)
```
    List of instance pools requested in the capacity task.
    
    Parameters:
    
    requestedInstancePools - List of instance pools requested in the capacity task.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDryRun
```
public void setDryRun(Boolean dryRun)
```
    Performs a dry run to determine if you are above or below instance capacity.
    
    Parameters:
    
    dryRun - Performs a dry run to determine if you are above or below instance capacity.
  - getDryRun
```
public Boolean getDryRun()
```
    Performs a dry run to determine if you are above or below instance capacity.
    
    Returns:
    
    Performs a dry run to determine if you are above or below instance capacity.
  - withDryRun
```
public GetCapacityTaskResult withDryRun(Boolean dryRun)
```
    Performs a dry run to determine if you are above or below instance capacity.
    
    Parameters:
    
    dryRun - Performs a dry run to determine if you are above or below instance capacity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDryRun
```
public Boolean isDryRun()
```
    Performs a dry run to determine if you are above or below instance capacity.
    
    Returns:
    
    Performs a dry run to determine if you are above or below instance capacity.
  - setCapacityTaskStatus
```
public void setCapacityTaskStatus(String capacityTaskStatus)
```
    Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    - REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    - IN_PROGRESS - The capacity task is running and cannot be cancelled.
    - WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    Parameters:
    capacityTaskStatus - Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    
    REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    
    IN_PROGRESS - The capacity task is running and cannot be cancelled.
    
    WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    See Also:
    
    CapacityTaskStatus
  - getCapacityTaskStatus
```
public String getCapacityTaskStatus()
```
    Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    - REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    - IN_PROGRESS - The capacity task is running and cannot be cancelled.
    - WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    Returns:
    Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    
    REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    
    IN_PROGRESS - The capacity task is running and cannot be cancelled.
    
    WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    See Also:
    
    CapacityTaskStatus
  - withCapacityTaskStatus
```
public GetCapacityTaskResult withCapacityTaskStatus(String capacityTaskStatus)
```
    Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    - REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    - IN_PROGRESS - The capacity task is running and cannot be cancelled.
    - WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    Parameters:
    capacityTaskStatus - Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    
    REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    
    IN_PROGRESS - The capacity task is running and cannot be cancelled.
    
    WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CapacityTaskStatus
  - withCapacityTaskStatus
```
public GetCapacityTaskResult withCapacityTaskStatus(CapacityTaskStatus capacityTaskStatus)
```
    Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    - REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    - IN_PROGRESS - The capacity task is running and cannot be cancelled.
    - WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    Parameters:
    capacityTaskStatus - Status of the capacity task.
    
    A capacity task can have one of the following statuses:
    
    REQUESTED - The capacity task was created and is awaiting the next step by Amazon Web Services Outposts.
    
    IN_PROGRESS - The capacity task is running and cannot be cancelled.
    
    WAITING_FOR_EVACUATION - The capacity task requires capacity to run. You must stop the recommended EC2 running instances to free up capacity for the task to run.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CapacityTaskStatus
  - setFailed
```
public void setFailed(CapacityTaskFailure failed)
```
    Reason why the capacity task failed.
    
    Parameters:
    
    failed - Reason why the capacity task failed.
  - getFailed
```
public CapacityTaskFailure getFailed()
```
    Reason why the capacity task failed.
    
    Returns:
    
    Reason why the capacity task failed.
  - withFailed
```
public GetCapacityTaskResult withFailed(CapacityTaskFailure failed)
```
    Reason why the capacity task failed.
    
    Parameters:
    
    failed - Reason why the capacity task failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the capacity task was created.
    
    Parameters:
    
    creationDate - The date the capacity task was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the capacity task was created.
    
    Returns:
    
    The date the capacity task was created.
  - withCreationDate
```
public GetCapacityTaskResult withCreationDate(Date creationDate)
```
    The date the capacity task was created.
    
    Parameters:
    
    creationDate - The date the capacity task was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCompletionDate
```
public void setCompletionDate(Date completionDate)
```
    The date the capacity task ran successfully.
    
    Parameters:
    
    completionDate - The date the capacity task ran successfully.
  - getCompletionDate
```
public Date getCompletionDate()
```
    The date the capacity task ran successfully.
    
    Returns:
    
    The date the capacity task ran successfully.
  - withCompletionDate
```
public GetCapacityTaskResult withCompletionDate(Date completionDate)
```
    The date the capacity task ran successfully.
    
    Parameters:
    
    completionDate - The date the capacity task ran successfully.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The date the capacity task was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the capacity task was last modified.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The date the capacity task was last modified.
    
    Returns:
    
    The date the capacity task was last modified.
  - withLastModifiedDate
```
public GetCapacityTaskResult withLastModifiedDate(Date lastModifiedDate)
```
    The date the capacity task was last modified.
    
    Parameters:
    
    lastModifiedDate - The date the capacity task was last modified.
    
    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 GetCapacityTaskResult clone()
```
    Overrides:
    
    clone in class Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class GetCapacityTaskResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetCapacityTaskResult

Method Detail

setCapacityTaskId

getCapacityTaskId

withCapacityTaskId

setOutpostId

getOutpostId

withOutpostId

setOrderId

getOrderId

withOrderId

getRequestedInstancePools

setRequestedInstancePools

withRequestedInstancePools

withRequestedInstancePools

setDryRun

getDryRun

withDryRun

isDryRun

setCapacityTaskStatus

getCapacityTaskStatus

withCapacityTaskStatus

withCapacityTaskStatus

setFailed

getFailed

withFailed

setCreationDate

getCreationDate

withCreationDate

setCompletionDate

getCompletionDate

withCompletionDate

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

toString

equals

hashCode

clone