Package software.amazon.awssdk.services.outposts.model

Class GetCapacityTaskResponse

    • Method Detail

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

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

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

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

        • 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

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

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

        • 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

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

      • 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