Package software.amazon.awssdk.services.ec2.model

Interface GetCapacityReservationUsageResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetCapacityReservationUsageResponse.Builder,GetCapacityReservationUsageResponse>, Ec2Response.Builder, SdkBuilder<GetCapacityReservationUsageResponse.Builder,GetCapacityReservationUsageResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetCapacityReservationUsageResponse

public static interface GetCapacityReservationUsageResponse.Builder
extends Ec2Response.Builder, SdkPojo, CopyableBuilder<GetCapacityReservationUsageResponse.Builder,GetCapacityReservationUsageResponse>

Method Summary

Modifier and Type	Method	Description
GetCapacityReservationUsageResponse.Builder	availableInstanceCount(Integer availableInstanceCount)	The remaining capacity.
GetCapacityReservationUsageResponse.Builder	capacityReservationId(String capacityReservationId)	The ID of the Capacity Reservation.
GetCapacityReservationUsageResponse.Builder	instanceType(String instanceType)	The type of instance for which the Capacity Reservation reserves capacity.
GetCapacityReservationUsageResponse.Builder	instanceUsages(Collection<InstanceUsage> instanceUsages)	Information about the Capacity Reservation usage.
GetCapacityReservationUsageResponse.Builder	instanceUsages(Consumer<InstanceUsage.Builder>... instanceUsages)	Information about the Capacity Reservation usage.
GetCapacityReservationUsageResponse.Builder	instanceUsages(InstanceUsage... instanceUsages)	Information about the Capacity Reservation usage.
GetCapacityReservationUsageResponse.Builder	nextToken(String nextToken)	The token to use to retrieve the next page of results.
GetCapacityReservationUsageResponse.Builder	state(String state)	The current state of the Capacity Reservation.
GetCapacityReservationUsageResponse.Builder	state(CapacityReservationState state)	The current state of the Capacity Reservation.
GetCapacityReservationUsageResponse.Builder	totalInstanceCount(Integer totalInstanceCount)	The number of instances for which the Capacity Reservation reserves capacity.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

nextToken

GetCapacityReservationUsageResponse.Builder nextToken(String nextToken)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Parameters:

nextToken - The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Returns:

Returns a reference to this object so that method calls can be chained together.

capacityReservationId

GetCapacityReservationUsageResponse.Builder capacityReservationId(String capacityReservationId)

The ID of the Capacity Reservation.

Parameters:

capacityReservationId - The ID of the Capacity Reservation.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceType

GetCapacityReservationUsageResponse.Builder instanceType(String instanceType)

The type of instance for which the Capacity Reservation reserves capacity.

Parameters:

instanceType - The type of instance for which the Capacity Reservation reserves capacity.

Returns:

Returns a reference to this object so that method calls can be chained together.

totalInstanceCount

GetCapacityReservationUsageResponse.Builder totalInstanceCount(Integer totalInstanceCount)

The number of instances for which the Capacity Reservation reserves capacity.

Parameters:

totalInstanceCount - The number of instances for which the Capacity Reservation reserves capacity.

Returns:

Returns a reference to this object so that method calls can be chained together.

availableInstanceCount

GetCapacityReservationUsageResponse.Builder availableInstanceCount(Integer availableInstanceCount)

The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

Parameters:

availableInstanceCount - The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

Returns:

Returns a reference to this object so that method calls can be chained together.

state

GetCapacityReservationUsageResponse.Builder state(String state)

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

Parameters:

state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityReservationState, CapacityReservationState

state

GetCapacityReservationUsageResponse.Builder state(CapacityReservationState state)

The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

Parameters:

state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

• active - The Capacity Reservation is active and the capacity is available for your use.

• expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.

• cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.

• pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

• failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CapacityReservationState, CapacityReservationState

instanceUsages

GetCapacityReservationUsageResponse.Builder instanceUsages(Collection<InstanceUsage> instanceUsages)

Information about the Capacity Reservation usage.

Parameters:

instanceUsages - Information about the Capacity Reservation usage.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceUsages

GetCapacityReservationUsageResponse.Builder instanceUsages(InstanceUsage... instanceUsages)

Information about the Capacity Reservation usage.

Parameters:

instanceUsages - Information about the Capacity Reservation usage.

Returns:

Returns a reference to this object so that method calls can be chained together.

instanceUsages

GetCapacityReservationUsageResponse.Builder instanceUsages(Consumer<InstanceUsage.Builder>... instanceUsages)

Information about the Capacity Reservation usage.

This is a convenience method that creates an instance of the InstanceUsage.Builder avoiding the need to create one manually via InstanceUsage.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #instanceUsages(List).

Parameters:

instanceUsages - a consumer that will call methods on InstanceUsage.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#instanceUsages(java.util.Collection)