Interface SearchCasesResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, ConnectCasesResponse.Builder, CopyableBuilder<SearchCasesResponse.Builder,SearchCasesResponse>, SdkBuilder<SearchCasesResponse.Builder,SearchCasesResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
SearchCasesResponse
@Mutable @NotThreadSafe public static interface SearchCasesResponse.Builder extends ConnectCasesResponse.Builder, SdkPojo, CopyableBuilder<SearchCasesResponse.Builder,SearchCasesResponse>

  • Method Details

    • nextToken

      SearchCasesResponse.Builder nextToken(String nextToken)

      The token for the next set of results. This is null if there are no more results to return.

      Parameters:
      nextToken - The token for the next set of results. This is null if there are no more results to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cases

      SearchCasesResponse.Builder cases(Collection<SearchCasesResponseItem> cases)

      A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

      Parameters:
      cases - A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cases

      SearchCasesResponse.Builder cases(SearchCasesResponseItem... cases)

      A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

      Parameters:
      cases - A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cases

      SearchCasesResponse.Builder cases(Consumer<SearchCasesResponseItem.Builder>... cases)

      A list of case documents where each case contains the properties CaseId and Fields where each field is a complex union structure.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cases(List<SearchCasesResponseItem>).

      Parameters:
      cases - a consumer that will call methods on SearchCasesResponseItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • totalCount

      SearchCasesResponse.Builder totalCount(Long totalCount)

      The total number of cases that matched the search criteria.

      Parameters:
      totalCount - The total number of cases that matched the search criteria.
      Returns:
      Returns a reference to this object so that method calls can be chained together.