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

Class DescribeCapacityReservationTopologyRequest

    • Method Detail

      • dryRun

        public final Boolean dryRun()

        Checks whether you have the required permissions for the operation, 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:
        Checks whether you have the required permissions for the operation, 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.

      • nextToken

        public final String nextToken()

        The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

        Returns:
        The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

      • maxResults

        public final 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.

        You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.

        Default: 10

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

        You can't specify this parameter and the Capacity Reservation IDs parameter in the same request.

        Default: 10

      • hasCapacityReservationIds

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

      • capacityReservationIds

        public final List<String> capacityReservationIds()

        The Capacity Reservation IDs.

        Default: Describes all your Capacity Reservations.

        Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.

        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 hasCapacityReservationIds() method.

        Returns:
        The Capacity Reservation IDs.

        Default: Describes all your Capacity Reservations.

        Constraints: Maximum 100 explicitly specified Capacity Reservation IDs.

      • hasFilters

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

      • filters

        public final List<Filter> filters()

        The filters.

        • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the Capacity Reservation is in.

        • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

        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 hasFilters() method.

        Returns:
        The filters.

        • availability-zone - The name of the Availability Zone (for example, us-west-2a) or Local Zone (for example, us-west-2-lax-1b) that the Capacity Reservation is in.

        • instance-type - The instance type (for example, p4d.24xlarge) or instance family (for example, p4d*). You can use the * wildcard to match zero or more characters, or the ? wildcard to match zero or one character.

      • 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