Package software.amazon.awssdk.services.connectcases.model

Interface SearchCasesRequest.Builder

    • Method Detail

      • domainId

        SearchCasesRequest.Builder domainId​(String domainId)

        The unique identifier of the Cases domain.

        Parameters:
        domainId - The unique identifier of the Cases domain.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fields

        SearchCasesRequest.Builder fields​(Collection<FieldIdentifier> fields)

        The list of field identifiers to be returned as part of the response.

        Parameters:
        fields - The list of field identifiers to be returned as part of the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • fields

        SearchCasesRequest.Builder fields​(FieldIdentifier... fields)

        The list of field identifiers to be returned as part of the response.

        Parameters:
        fields - The list of field identifiers to be returned as part of the response.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filter

        SearchCasesRequest.Builder filter​(CaseFilter filter)

        A list of filter objects.

        Parameters:
        filter - A list of filter objects.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        SearchCasesRequest.Builder maxResults​(Integer maxResults)

        The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.

        Parameters:
        maxResults - The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        SearchCasesRequest.Builder nextToken​(String nextToken)

        The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

        Parameters:
        nextToken - The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • searchTerm

        SearchCasesRequest.Builder searchTerm​(String searchTerm)

        A word or phrase used to perform a quick search.

        Parameters:
        searchTerm - A word or phrase used to perform a quick search.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sorts

        SearchCasesRequest.Builder sorts​(Collection<Sort> sorts)

        A list of sorts where each sort specifies a field and their sort order to be applied to the results.

        Parameters:
        sorts - A list of sorts where each sort specifies a field and their sort order to be applied to the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sorts

        SearchCasesRequest.Builder sorts​(Sort... sorts)

        A list of sorts where each sort specifies a field and their sort order to be applied to the results.

        Parameters:
        sorts - A list of sorts where each sort specifies a field and their sort order to be applied to the results.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sorts

        SearchCasesRequest.Builder sorts​(Consumer<Sort.Builder>... sorts)

        A list of sorts where each sort specifies a field and their sort order to be applied to the results.

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

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

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