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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceStartCapacityTaskResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartCapacityTaskResponse.Builderbuilder()StringcapacityTaskId()ID of the capacity task that you want to start.CapacityTaskStatuscapacityTaskStatus()Status of the specified capacity task.StringcapacityTaskStatusAsString()Status of the specified capacity task.InstantcompletionDate()Date that the specified capacity task ran successfully.InstantcreationDate()Date that the specified capacity task was created.BooleandryRun()Results of the dry run showing if the specified capacity task is above or below the available instance capacity.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)CapacityTaskFailurefailed()Reason that the specified capacity task failed.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasRequestedInstancePools()For responses, this returns true if the service returned a value for the RequestedInstancePools property.InstantlastModifiedDate()Date that the specified capacity task was last modified.StringorderId()ID of the Amazon Web Services Outposts order of the host associated with the capacity task.StringoutpostId()ID of the Outpost associated with the capacity task.List<InstanceTypeCapacity>requestedInstancePools()List of the instance pools requested in the specified capacity task.List<SdkField<?>>sdkFields()static Class<? extends StartCapacityTaskResponse.Builder>serializableBuilderClass()StartCapacityTaskResponse.BuildertoBuilder()StringtoString()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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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.
-
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
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.
-
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,
capacityTaskStatuswill returnCapacityTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcapacityTaskStatusAsString().- Returns:
- Status of the specified capacity task.
- See Also:
CapacityTaskStatus
-
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,
capacityTaskStatuswill returnCapacityTaskStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromcapacityTaskStatusAsString().- Returns:
- Status of the specified capacity task.
- See Also:
CapacityTaskStatus
-
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.
-
toBuilder
public StartCapacityTaskResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<StartCapacityTaskResponse.Builder,StartCapacityTaskResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static StartCapacityTaskResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartCapacityTaskResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-