Class GetCapacityTaskResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.outposts.model.OutpostsResponse
software.amazon.awssdk.services.outposts.model.GetCapacityTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetCapacityTaskResponse extends OutpostsResponse implements ToCopyableBuilder<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>

  • Method Details

    • capacityTaskId

      public final String capacityTaskId()

      ID of the capacity task.

      Returns:
      ID of the capacity task.

    • outpostId

      public final String outpostId()

      ID of the Outpost associated with the specified capacity task.

      Returns:
      ID of the Outpost associated with the specified capacity task.

    • orderId

      public final String 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.

    • assetId

      public final String assetId()

      The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

      Returns:
      The ID of the Outpost asset. An Outpost asset can be a single server within an Outposts rack or an Outposts server configuration.

    • 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 the isEmpty() 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

      public final List<InstanceTypeCapacity> 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.

    • instancesToExclude

      public final InstancesToExclude instancesToExclude()

      Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.

      Returns:
      Instances that the user specified they cannot stop in order to free up the capacity needed to run the capacity task.

    • dryRun

      public final Boolean 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

      public final 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.

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

      • 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.

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

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

      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.

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

      • 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.

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

      See Also:

    • capacityTaskStatusAsString

      public final String 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.

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

      • 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.

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

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

      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.

      • FAILED - The capacity task could not be completed.

      • COMPLETED - The capacity task has completed successfully.

      • 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.

      • CANCELLATION_IN_PROGRESS - The capacity task has been cancelled and is in the process of cleaning up resources.

      • CANCELLED - The capacity task is cancelled.

      See Also:

    • failed

      public final CapacityTaskFailure failed()

      Reason why the capacity task failed.

      Returns:
      Reason why the capacity task failed.

    • creationDate

      public final Instant creationDate()

      The date the capacity task was created.

      Returns:
      The date the capacity task was created.

    • completionDate

      public final Instant completionDate()

      The date the capacity task ran successfully.

      Returns:
      The date the capacity task ran successfully.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The date the capacity task was last modified.

      Returns:
      The date the capacity task was last modified.

    • taskActionOnBlockingInstances

      public final TaskActionOnBlockingInstances taskActionOnBlockingInstances()

      User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:

      • WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

      • FAIL_TASK - The capacity task fails.

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

      Returns:
      User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:

      • WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

      • FAIL_TASK - The capacity task fails.

      See Also:

    • taskActionOnBlockingInstancesAsString

      public final String taskActionOnBlockingInstancesAsString()

      User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:

      • WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

      • FAIL_TASK - The capacity task fails.

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

      Returns:
      User-specified option in case an instance is blocking the capacity task from running. Shows one of the following options:

      • WAIT_FOR_EVACUATION - Checks every 10 minutes over 48 hours to determine if instances have stopped and capacity is available to complete the task.

      • FAIL_TASK - The capacity task fails.

      See Also:

    • toBuilder

      public GetCapacityTaskResponse.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<GetCapacityTaskResponse.Builder,GetCapacityTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetCapacityTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCapacityTaskResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.