Interface DescribeCapacityBlocksRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeCapacityBlocksRequest.Builder,DescribeCapacityBlocksRequest>, Ec2Request.Builder, SdkBuilder<DescribeCapacityBlocksRequest.Builder,DescribeCapacityBlocksRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeCapacityBlocksRequest
@Mutable @NotThreadSafe public static interface DescribeCapacityBlocksRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeCapacityBlocksRequest.Builder,DescribeCapacityBlocksRequest>

  • Method Details

    • capacityBlockIds

      DescribeCapacityBlocksRequest.Builder capacityBlockIds(Collection<String> capacityBlockIds)

      The IDs of the Capacity Blocks.

      Parameters:
      capacityBlockIds - The IDs of the Capacity Blocks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • capacityBlockIds

      DescribeCapacityBlocksRequest.Builder capacityBlockIds(String... capacityBlockIds)

      The IDs of the Capacity Blocks.

      Parameters:
      capacityBlockIds - The IDs of the Capacity Blocks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeCapacityBlocksRequest.Builder nextToken(String nextToken)

      The token to use to retrieve the next page of results.

      Parameters:
      nextToken - The token to use to retrieve the next page of results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeCapacityBlocksRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.

      Parameters:
      maxResults - The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeCapacityBlocksRequest.Builder filters(Collection<Filter> filters)

      One or more filters.

      • capacity-block-id - The ID of the Capacity Block.

      • ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

      • availability-zone - The Availability Zone of the Capacity Block.

      • start-date - The date and time at which the Capacity Block was started.

      • end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

      • create-date - The date and time at which the Capacity Block was created.

      • state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

      • tags - The tags assigned to the Capacity Block.

      Parameters:
      filters - One or more filters.

      • capacity-block-id - The ID of the Capacity Block.

      • ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

      • availability-zone - The Availability Zone of the Capacity Block.

      • start-date - The date and time at which the Capacity Block was started.

      • end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

      • create-date - The date and time at which the Capacity Block was created.

      • state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

      • tags - The tags assigned to the Capacity Block.

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

    • filters

      DescribeCapacityBlocksRequest.Builder filters(Filter... filters)

      One or more filters.

      • capacity-block-id - The ID of the Capacity Block.

      • ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

      • availability-zone - The Availability Zone of the Capacity Block.

      • start-date - The date and time at which the Capacity Block was started.

      • end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

      • create-date - The date and time at which the Capacity Block was created.

      • state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

      • tags - The tags assigned to the Capacity Block.

      Parameters:
      filters - One or more filters.

      • capacity-block-id - The ID of the Capacity Block.

      • ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

      • availability-zone - The Availability Zone of the Capacity Block.

      • start-date - The date and time at which the Capacity Block was started.

      • end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

      • create-date - The date and time at which the Capacity Block was created.

      • state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

      • tags - The tags assigned to the Capacity Block.

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

    • filters

      DescribeCapacityBlocksRequest.Builder filters(Consumer<Filter.Builder>... filters)

      One or more filters.

      • capacity-block-id - The ID of the Capacity Block.

      • ultraserver-type - The Capacity Block type. The type can be instances or ultraservers.

      • availability-zone - The Availability Zone of the Capacity Block.

      • start-date - The date and time at which the Capacity Block was started.

      • end-date - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.

      • create-date - The date and time at which the Capacity Block was created.

      • state - The state of the Capacity Block (active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed).

      • tags - The tags assigned to the Capacity Block.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dryRun

      DescribeCapacityBlocksRequest.Builder dryRun(Boolean dryRun)

      Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeCapacityBlocksRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeCapacityBlocksRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.