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

Class StartCapacityTaskResponse

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.StartCapacityTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartCapacityTaskResponse.Builder,StartCapacityTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class StartCapacityTaskResponse extends OutpostsResponse implements ToCopyableBuilder<StartCapacityTaskResponse.Builder,StartCapacityTaskResponse>

  • Method Details

    • capacityTaskId

      public final String capacityTaskId()

      ID of the capacity task that you want to start.

      Returns:
      ID of the capacity task that you want to start.

    • outpostId

      public final String outpostId()

      ID of the Outpost associated with the capacity task.

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

    • orderId

      public final String orderId()

      ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

      Returns:
      ID of the Amazon Web Services Outposts order of the host associated with the capacity task.

    • assetId

      public final String assetId()

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

      Returns:
      The ID of the 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 the instance pools requested in the specified 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 the instance pools requested in the specified capacity task.

    • instancesToExclude

      public final InstancesToExclude instancesToExclude()

      User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.

      Returns:
      User-specified instances that must not be stopped in order to free up the capacity needed to run the capacity task.

    • dryRun

      public final Boolean dryRun()

      Results of the dry run showing if the specified capacity task is above or below the available instance capacity.

      Returns:
      Results of the dry run showing if the specified capacity task is above or below the available instance capacity.

    • capacityTaskStatus

      public final CapacityTaskStatus capacityTaskStatus()

      Status of the specified capacity task.

      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 specified capacity task.
      See Also:

    • capacityTaskStatusAsString

      public final String capacityTaskStatusAsString()

      Status of the specified capacity task.

      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 specified capacity task.
      See Also:

    • failed

      public final CapacityTaskFailure failed()

      Reason that the specified capacity task failed.

      Returns:
      Reason that the specified capacity task failed.

    • creationDate

      public final Instant creationDate()

      Date that the specified capacity task was created.

      Returns:
      Date that the specified capacity task was created.

    • completionDate

      public final Instant completionDate()

      Date that the specified capacity task ran successfully.

      Returns:
      Date that the specified capacity task ran successfully.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      Date that the specified capacity task was last modified.

      Returns:
      Date that the specified capacity task was last modified.

    • taskActionOnBlockingInstances

      public final TaskActionOnBlockingInstances taskActionOnBlockingInstances()

      User-specified option in case an instance is blocking the capacity task from running.

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

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

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

      • 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 StartCapacityTaskResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartCapacityTaskResponse.Builder,StartCapacityTaskResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static StartCapacityTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartCapacityTaskResponse.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo