co.elastic.clients.elasticsearch.sql.QueryResponse Maven / Gradle / Ivy
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. 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 co.elastic.clients.elasticsearch.sql;
import co.elastic.clients.json.JsonData;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: sql.query.Response
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class QueryResponse implements JsonpSerializable {
@Nullable
private final String id;
@Nullable
private final Boolean isRunning;
@Nullable
private final Boolean isPartial;
private final List columns;
@Nullable
private final String cursor;
private final List> rows;
// ---------------------------------------------------------------------------------------------
private QueryResponse(Builder builder) {
this.id = builder.id;
this.isRunning = builder.isRunning;
this.isPartial = builder.isPartial;
this.columns = ApiTypeHelper.unmodifiable(builder.columns);
this.cursor = builder.cursor;
this.rows = ApiTypeHelper.unmodifiableRequired(builder.rows, this, "rows");
}
public static QueryResponse of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Identifier for the search. This value is only returned for async and saved
* synchronous searches. For CSV, TSV, and TXT responses, this value is returned
* in the Async-ID HTTP header.
*
* API name: {@code id}
*/
@Nullable
public final String id() {
return this.id;
}
/**
* If true, the search is still running. If false, the search has
* finished. This value is only returned for async and saved synchronous
* searches. For CSV, TSV, and TXT responses, this value is returned in the
* Async-partial HTTP header.
*
* API name: {@code is_running}
*/
@Nullable
public final Boolean isRunning() {
return this.isRunning;
}
/**
* If true, the response does not contain complete search results.
* If is_partial is true and is_running
* is true, the search is still running. If is_partial
* is true but is_running is false, the
* results are partial due to a failure or timeout. This value is only returned
* for async and saved synchronous searches. For CSV, TSV, and TXT responses,
* this value is returned in the Async-partial HTTP header.
*
* API name: {@code is_partial}
*/
@Nullable
public final Boolean isPartial() {
return this.isPartial;
}
/**
* Column headings for the search results. Each object is a column.
*
* API name: {@code columns}
*/
public final List columns() {
return this.columns;
}
/**
* Cursor for the next set of paginated results. For CSV, TSV, and TXT
* responses, this value is returned in the Cursor HTTP header.
*
* API name: {@code cursor}
*/
@Nullable
public final String cursor() {
return this.cursor;
}
/**
* Required - Values for the search results.
*
* API name: {@code rows}
*/
public final List> rows() {
return this.rows;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
if (this.id != null) {
generator.writeKey("id");
generator.write(this.id);
}
if (this.isRunning != null) {
generator.writeKey("is_running");
generator.write(this.isRunning);
}
if (this.isPartial != null) {
generator.writeKey("is_partial");
generator.write(this.isPartial);
}
if (ApiTypeHelper.isDefined(this.columns)) {
generator.writeKey("columns");
generator.writeStartArray();
for (Column item0 : this.columns) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.cursor != null) {
generator.writeKey("cursor");
generator.write(this.cursor);
}
if (ApiTypeHelper.isDefined(this.rows)) {
generator.writeKey("rows");
generator.writeStartArray();
for (List item0 : this.rows) {
generator.writeStartArray();
if (item0 != null) {
for (JsonData item1 : item0) {
item1.serialize(generator, mapper);
}
}
generator.writeEnd();
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link QueryResponse}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private String id;
@Nullable
private Boolean isRunning;
@Nullable
private Boolean isPartial;
@Nullable
private List columns;
@Nullable
private String cursor;
private List> rows;
/**
* Identifier for the search. This value is only returned for async and saved
* synchronous searches. For CSV, TSV, and TXT responses, this value is returned
* in the Async-ID HTTP header.
*
* API name: {@code id}
*/
public final Builder id(@Nullable String value) {
this.id = value;
return this;
}
/**
* If true, the search is still running. If false, the search has
* finished. This value is only returned for async and saved synchronous
* searches. For CSV, TSV, and TXT responses, this value is returned in the
* Async-partial HTTP header.
*
* API name: {@code is_running}
*/
public final Builder isRunning(@Nullable Boolean value) {
this.isRunning = value;
return this;
}
/**
* If true, the response does not contain complete search results.
* If is_partial is true and is_running
* is true, the search is still running. If is_partial
* is true but is_running is false, the
* results are partial due to a failure or timeout. This value is only returned
* for async and saved synchronous searches. For CSV, TSV, and TXT responses,
* this value is returned in the Async-partial HTTP header.
*
* API name: {@code is_partial}
*/
public final Builder isPartial(@Nullable Boolean value) {
this.isPartial = value;
return this;
}
/**
* Column headings for the search results. Each object is a column.
*
* API name: {@code columns}
*
* Adds all elements of list to columns.
*/
public final Builder columns(List list) {
this.columns = _listAddAll(this.columns, list);
return this;
}
/**
* Column headings for the search results. Each object is a column.
*
* API name: {@code columns}
*
* Adds one or more values to columns.
*/
public final Builder columns(Column value, Column... values) {
this.columns = _listAdd(this.columns, value, values);
return this;
}
/**
* Column headings for the search results. Each object is a column.
*
* API name: {@code columns}
*
* Adds a value to columns using a builder lambda.
*/
public final Builder columns(Function> fn) {
return columns(fn.apply(new Column.Builder()).build());
}
/**
* Cursor for the next set of paginated results. For CSV, TSV, and TXT
* responses, this value is returned in the Cursor HTTP header.
*
* API name: {@code cursor}
*/
public final Builder cursor(@Nullable String value) {
this.cursor = value;
return this;
}
/**
* Required - Values for the search results.
*
* API name: {@code rows}
*
* Adds all elements of list to rows.
*/
public final Builder rows(List> list) {
this.rows = _listAddAll(this.rows, list);
return this;
}
/**
* Required - Values for the search results.
*
* API name: {@code rows}
*
* Adds one or more values to rows.
*/
public final Builder rows(List value, List... values) {
this.rows = _listAdd(this.rows, value, values);
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link QueryResponse}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public QueryResponse build() {
_checkSingleUse();
return new QueryResponse(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link QueryResponse}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
QueryResponse::setupQueryResponseDeserializer);
protected static void setupQueryResponseDeserializer(ObjectDeserializer op) {
op.add(Builder::id, JsonpDeserializer.stringDeserializer(), "id");
op.add(Builder::isRunning, JsonpDeserializer.booleanDeserializer(), "is_running");
op.add(Builder::isPartial, JsonpDeserializer.booleanDeserializer(), "is_partial");
op.add(Builder::columns, JsonpDeserializer.arrayDeserializer(Column._DESERIALIZER), "columns");
op.add(Builder::cursor, JsonpDeserializer.stringDeserializer(), "cursor");
op.add(Builder::rows,
JsonpDeserializer.arrayDeserializer(JsonpDeserializer.arrayDeserializer(JsonData._DESERIALIZER)),
"rows");
}
}