Class StartCapacityTaskRequest

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

  • Method Details

    • outpostIdentifier

      public final String outpostIdentifier()

      The ID or ARN of the Outposts associated with the specified capacity task.

      Returns:
      The ID or ARN of the Outposts associated with the specified capacity task.

    • orderId

      public final String orderId()

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

      Returns:
      The 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.

    • hasInstancePools

      public final boolean hasInstancePools()
      For responses, this returns true if the service returned a value for the InstancePools 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.

    • instancePools

      public final List<InstanceTypeCapacity> instancePools()

      The instance pools specified 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 hasInstancePools() method.

      Returns:
      The instance pools specified in the capacity task.

    • instancesToExclude

      public final InstancesToExclude instancesToExclude()

      List of user-specified running instances that must not be stopped in order to free up the capacity needed to run the capacity task.

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

    • dryRun

      public final Boolean dryRun()

      You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

      Returns:
      You can request a dry run to determine if the instance type and instance size changes is above or below available instance capacity. Requesting a dry run does not make any changes to your plan.

    • taskActionOnBlockingInstances

      public final TaskActionOnBlockingInstances taskActionOnBlockingInstances()

      Specify one of the following options 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:
      Specify one of the following options 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()

      Specify one of the following options 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:
      Specify one of the following options 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 StartCapacityTaskRequest.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<StartCapacityTaskRequest.Builder,StartCapacityTaskRequest>
      Specified by:
      toBuilder in class OutpostsRequest
      Returns:
      a builder for type T

    • builder

      public static StartCapacityTaskRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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