Interface DescribeHostReservationsRequest.Builder

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

  • Method Details

    • filter

      DescribeHostReservationsRequest.Builder filter(Collection<Filter> filter)

      The filters.

      • instance-family - The instance family (for example, m4).

      • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

      • state - The state of the reservation (payment-pending | payment-failed | active | retired).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      Parameters:
      filter - The filters.

      • instance-family - The instance family (for example, m4).

      • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

      • state - The state of the reservation (payment-pending | payment-failed | active | retired).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

    • filter

      DescribeHostReservationsRequest.Builder filter(Filter... filter)

      The filters.

      • instance-family - The instance family (for example, m4).

      • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

      • state - The state of the reservation (payment-pending | payment-failed | active | retired).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      Parameters:
      filter - The filters.

      • instance-family - The instance family (for example, m4).

      • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

      • state - The state of the reservation (payment-pending | payment-failed | active | retired).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

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

    • filter

      DescribeHostReservationsRequest.Builder filter(Consumer<Filter.Builder>... filter)

      The filters.

      • instance-family - The instance family (for example, m4).

      • payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).

      • state - The state of the reservation (payment-pending | payment-failed | active | retired).

      • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

      • tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

      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 filter(List<Filter>).

      Parameters:
      filter - 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:

    • hostReservationIdSet

      DescribeHostReservationsRequest.Builder hostReservationIdSet(Collection<String> hostReservationIdSet)

      The host reservation IDs.

      Parameters:
      hostReservationIdSet - The host reservation IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hostReservationIdSet

      DescribeHostReservationsRequest.Builder hostReservationIdSet(String... hostReservationIdSet)

      The host reservation IDs.

      Parameters:
      hostReservationIdSet - The host reservation IDs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      DescribeHostReservationsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.

      Parameters:
      maxResults - The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

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

    • overrideConfiguration

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

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