org.elasticsearch.action.search.ClearScrollRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you 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.elasticsearch.action.search;
import org.elasticsearch.action.ActionRequest;
import org.elasticsearch.action.ActionRequestValidationException;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import static org.elasticsearch.action.ValidateActions.addValidationError;
/**
*/
public class ClearScrollRequest extends ActionRequest {
private List scrollIds;
public ClearScrollRequest() {
}
/**
* Creates a clear scroll request caused by some other request, which is provided as an
* argument so that its headers and context can be copied to the new request
*/
public ClearScrollRequest(ActionRequest request) {
super(request);
}
public List getScrollIds() {
return scrollIds;
}
public void setScrollIds(List scrollIds) {
this.scrollIds = scrollIds;
}
public void addScrollId(String scrollId) {
if (scrollIds == null) {
scrollIds = new ArrayList<>();
}
scrollIds.add(scrollId);
}
public List scrollIds() {
return scrollIds;
}
public void scrollIds(List scrollIds) {
this.scrollIds = scrollIds;
}
@Override
public ActionRequestValidationException validate() {
ActionRequestValidationException validationException = null;
if (scrollIds == null || scrollIds.isEmpty()) {
validationException = addValidationError("no scroll ids specified", validationException);
}
return validationException;
}
@Override
public void readFrom(StreamInput in) throws IOException {
super.readFrom(in);
scrollIds = Arrays.asList(in.readStringArray());
}
@Override
public void writeTo(StreamOutput out) throws IOException {
super.writeTo(out);
if (scrollIds == null) {
out.writeVInt(0);
} else {
out.writeStringArray(scrollIds.toArray(new String[scrollIds.size()]));
}
}
}