org.projectnessie.model.PaginatedResponse Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Dremio
*
* 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 org.projectnessie.model;
import com.fasterxml.jackson.annotation.JsonProperty;
import javax.annotation.Nullable;
import javax.validation.constraints.Size;
import org.immutables.value.Value.Default;
public interface PaginatedResponse {
/**
* Whether there are more result-items than returned by this response object.
*
* If there are more result-items, the value returned by {@link #getToken()} can be used in the
* next invocation to get the next "page" of results.
*
* @return {@code true}, if there are more result items.
*/
@Default
@JsonProperty(value = "hasMore")
default boolean isHasMore() {
return false;
}
/**
* Pass this value to the next invocation of the API function to get the next page of results.
*
*
Paging tokens are opaque and the structure may change without prior notice even in patch
* releases.
*
* @return paging continuation token for the next invocation of an API function supporting
* pagination, if {@link #isHasMore()} is {@code true}. Undefined, if {@link #isHasMore()} is
* {@code false}.
*/
@Nullable
@jakarta.annotation.Nullable
@Size
@jakarta.validation.constraints.Size(min = 1)
String getToken();
}