Class GetCapacityTaskResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetCapacityTaskResponse.Builder,
GetCapacityTaskResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
ID of the capacity task.final CapacityTaskStatus
Status of the capacity task.final String
Status of the capacity task.final Instant
The date the capacity task ran successfully.final Instant
The date the capacity task was created.final Boolean
dryRun()
Performs a dry run to determine if you are above or below instance capacity.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final CapacityTaskFailure
failed()
Reason why the capacity task failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequestedInstancePools property.final Instant
The date the capacity task was last modified.final String
orderId()
ID of the Amazon Web Services Outposts order associated with the specified capacity task.final String
ID of the Outpost associated with the specified capacity task.final List
<InstanceTypeCapacity> List of instance pools requested in the capacity task.static Class
<? extends GetCapacityTaskResponse.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.outposts.model.OutpostsResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
capacityTaskId
ID of the capacity task.
- Returns:
- ID of the capacity task.
-
outpostId
ID of the Outpost associated with the specified capacity task.
- Returns:
- ID of the Outpost associated with the specified capacity task.
-
orderId
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.
-
hasRequestedInstancePools
public final boolean hasRequestedInstancePools()For responses, this returns true if the service returned a value for the RequestedInstancePools property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
requestedInstancePools
List of instance pools requested in the capacity task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRequestedInstancePools()
method.- Returns:
- List of instance pools requested in the capacity task.
-
dryRun
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.
-
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.
If the service returns an enum value that is not available in the current SDK version,
capacityTaskStatus
will returnCapacityTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcapacityTaskStatusAsString()
.- 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:
-
-
capacityTaskStatusAsString
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.
If the service returns an enum value that is not available in the current SDK version,
capacityTaskStatus
will returnCapacityTaskStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcapacityTaskStatusAsString()
.- 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:
-
-
failed
Reason why the capacity task failed.
- Returns:
- Reason why the capacity task failed.
-
creationDate
The date the capacity task was created.
- Returns:
- The date the capacity task was created.
-
completionDate
The date the capacity task ran successfully.
- Returns:
- The date the capacity task ran successfully.
-
lastModifiedDate
The date the capacity task was last modified.
- Returns:
- The date the capacity task was last modified.
-
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 interfaceToCopyableBuilder<GetCapacityTaskResponse.Builder,
GetCapacityTaskResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-