Package software.amazon.awssdk.services.batch.model

Interface ListConsumableResourcesRequest.Builder

    • Method Detail

      • filters

        ListConsumableResourcesRequest.Builder filters​(Collection<KeyValuesPair> filters)

        The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

        • name: CONSUMABLE_RESOURCE_NAME

          values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.

        Parameters:
        filters - The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

        • name: CONSUMABLE_RESOURCE_NAME

          values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.

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

      • filters

        ListConsumableResourcesRequest.Builder filters​(KeyValuesPair... filters)

        The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

        • name: CONSUMABLE_RESOURCE_NAME

          values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.

        Parameters:
        filters - The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

        • name: CONSUMABLE_RESOURCE_NAME

          values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.

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

      • filters

        ListConsumableResourcesRequest.Builder filters​(Consumer<KeyValuesPair.Builder>... filters)

        The filters to apply to the consumable resource list query. If used, only those consumable resources that match the filter are listed. Filter names and values can be:

        • name: CONSUMABLE_RESOURCE_NAME

          values: case-insensitive matches for the consumable resource name. If a filter value ends with an asterisk (*), it matches any consumable resource name that begins with the string before the '*'.

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

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

        Parameters:
        filters - a consumer that will call methods on KeyValuesPair.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #filters(java.util.Collection)

      • maxResults

        ListConsumableResourcesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results returned by ListConsumableResources in paginated output. When this parameter is used, ListConsumableResources only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListConsumableResources request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListConsumableResources returns up to 100 results and a nextToken value if applicable.

        Parameters:
        maxResults - The maximum number of results returned by ListConsumableResources in paginated output. When this parameter is used, ListConsumableResources only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListConsumableResources request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListConsumableResources returns up to 100 results and a nextToken value if applicable.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        ListConsumableResourcesRequest.Builder nextToken​(String nextToken)

        The nextToken value returned from a previous paginated ListConsumableResources request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

        Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

        Parameters:
        nextToken - The nextToken value returned from a previous paginated ListConsumableResources request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

        Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

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