io.fusionauth.domain.api.user.SearchResponse Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of fusionauth-java-client Show documentation

The Java Client library provides a native Java binding to the FusionAuth REST API.

There is a newer version: 1.53.0

Show newest version

/*
 * Copyright (c) 2018-2023, FusionAuth, All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific
 * language governing permissions and limitations under the License.
 */
package io.fusionauth.domain.api.user;

import java.util.List;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.inversoft.json.JacksonConstructor;
import io.fusionauth.domain.User;
import io.fusionauth.domain.api.ExpandableResponse;
import io.fusionauth.domain.search.SearchResults;

/**
 * Search API response.
 *
 * @author Brian Pontarelli
 */
public class SearchResponse extends ExpandableResponse {
  public long total;

  public String nextResults;

  // When this is 'true', it indicates the total returned may not be the actual number of users matching the query.
  // - The search index will cap the total hit count to limit query performance, once this limit is reached the count no longer increments.
  // - To request an accurate total, see 'accurateTotal' on the API request.
  // Not returning this on the API for now, Elasticsearch does not seem to provide a reliable answer, it is simply and indicator.
  @JsonIgnore
  public boolean totalEqualToActual;

  public List users;

  @JacksonConstructor
  public SearchResponse() {
  }

  public SearchResponse(SearchResults searchResults) {
    total = searchResults.total;
    users = searchResults.results;
  }
}