/*
 * Copyright 2020-2024 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.elasticsearch.core;

import org.springframework.lang.Nullable;

/**
 * This interface is used to expose the current {@code scrollId} from the underlying scroll context.
 * <p>
 * Internal use only.
 * 
 * @author Sascha Woo
 * @author Peter-Josef Meisch
 * @param <T>
 * @since 4.0
 */
public interface SearchScrollHits<T> extends SearchHits<T> {

	/**
	 * @return the scroll id
	 */
	@Nullable
	String getScrollId();

}
