Package software.amazon.awssdk.services.resourceexplorer2.model

Interface ListIndexesRequest.Builder

    • Method Detail

      • maxResults

        ListIndexesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

        An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

        Parameters:
        maxResults - The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

        An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

      • nextToken

        ListIndexesRequest.Builder nextToken​(String nextToken)

        The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

        Parameters:
        nextToken - The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regions

        ListIndexesRequest.Builder regions​(Collection<String> regions)

        If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

        Parameters:
        regions - If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • regions

        ListIndexesRequest.Builder regions​(String... regions)

        If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

        Parameters:
        regions - If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • type

        ListIndexesRequest.Builder type​(String type)

        If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

        Use this option to discover the aggregator index for your account.

        Parameters:
        type - If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

        Use this option to discover the aggregator index for your account.

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

      • type

        ListIndexesRequest.Builder type​(IndexType type)

        If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

        Use this option to discover the aggregator index for your account.

        Parameters:
        type - If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

        Use this option to discover the aggregator index for your account.

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