co.elastic.clients.elasticsearch.eql.EqlSearchResponseBase Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* 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.eql;
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.JsonpSerializer;
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.Long;
import java.lang.String;
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: eql._types.EqlSearchResponseBase
/**
*
* @see API
* specification
*/
public abstract class EqlSearchResponseBase implements JsonpSerializable {
@Nullable
private final String id;
@Nullable
private final Boolean isPartial;
@Nullable
private final Boolean isRunning;
@Nullable
private final Long took;
@Nullable
private final Boolean timedOut;
private final EqlHits hits;
@Nullable
private final JsonpSerializer tEventSerializer;
// ---------------------------------------------------------------------------------------------
protected EqlSearchResponseBase(AbstractBuilder builder) {
this.id = builder.id;
this.isPartial = builder.isPartial;
this.isRunning = builder.isRunning;
this.took = builder.took;
this.timedOut = builder.timedOut;
this.hits = ApiTypeHelper.requireNonNull(builder.hits, this, "hits");
this.tEventSerializer = builder.tEventSerializer;
}
/**
* Identifier for the search.
*
* API name: {@code id}
*/
@Nullable
public final String id() {
return this.id;
}
/**
* If true, the response does not contain complete search results.
*
* API name: {@code is_partial}
*/
@Nullable
public final Boolean isPartial() {
return this.isPartial;
}
/**
* If true, the search request is still executing.
*
* API name: {@code is_running}
*/
@Nullable
public final Boolean isRunning() {
return this.isRunning;
}
/**
* Milliseconds it took Elasticsearch to execute the request.
*
* API name: {@code took}
*/
@Nullable
public final Long took() {
return this.took;
}
/**
* If true, the request timed out before completion.
*
* API name: {@code timed_out}
*/
@Nullable
public final Boolean timedOut() {
return this.timedOut;
}
/**
* Required - Contains matching events and sequences. Also contains related
* metadata.
*
* API name: {@code hits}
*/
public final EqlHits hits() {
return this.hits;
}
/**
* 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.isPartial != null) {
generator.writeKey("is_partial");
generator.write(this.isPartial);
}
if (this.isRunning != null) {
generator.writeKey("is_running");
generator.write(this.isRunning);
}
if (this.took != null) {
generator.writeKey("took");
generator.write(this.took);
}
if (this.timedOut != null) {
generator.writeKey("timed_out");
generator.write(this.timedOut);
}
generator.writeKey("hits");
this.hits.serialize(generator, mapper);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
public abstract static class AbstractBuilder>
extends
WithJsonObjectBuilderBase {
@Nullable
private String id;
@Nullable
private Boolean isPartial;
@Nullable
private Boolean isRunning;
@Nullable
private Long took;
@Nullable
private Boolean timedOut;
private EqlHits hits;
@Nullable
private JsonpSerializer tEventSerializer;
/**
* Identifier for the search.
*
* API name: {@code id}
*/
public final BuilderT id(@Nullable String value) {
this.id = value;
return self();
}
/**
* If true, the response does not contain complete search results.
*
* API name: {@code is_partial}
*/
public final BuilderT isPartial(@Nullable Boolean value) {
this.isPartial = value;
return self();
}
/**
* If true, the search request is still executing.
*
* API name: {@code is_running}
*/
public final BuilderT isRunning(@Nullable Boolean value) {
this.isRunning = value;
return self();
}
/**
* Milliseconds it took Elasticsearch to execute the request.
*
* API name: {@code took}
*/
public final BuilderT took(@Nullable Long value) {
this.took = value;
return self();
}
/**
* If true, the request timed out before completion.
*
* API name: {@code timed_out}
*/
public final BuilderT timedOut(@Nullable Boolean value) {
this.timedOut = value;
return self();
}
/**
* Required - Contains matching events and sequences. Also contains related
* metadata.
*
* API name: {@code hits}
*/
public final BuilderT hits(EqlHits value) {
this.hits = value;
return self();
}
/**
* Required - Contains matching events and sequences. Also contains related
* metadata.
*
* API name: {@code hits}
*/
public final BuilderT hits(Function, ObjectBuilder>> fn) {
return this.hits(fn.apply(new EqlHits.Builder()).build());
}
/**
* Serializer for TEvent. If not set, an attempt will be made to find a
* serializer from the JSON context.
*/
public final BuilderT tEventSerializer(@Nullable JsonpSerializer value) {
this.tEventSerializer = value;
return self();
}
protected abstract BuilderT self();
}
// ---------------------------------------------------------------------------------------------
protected static > void setupEqlSearchResponseBaseDeserializer(
ObjectDeserializer op, JsonpDeserializer tEventDeserializer) {
op.add(AbstractBuilder::id, JsonpDeserializer.stringDeserializer(), "id");
op.add(AbstractBuilder::isPartial, JsonpDeserializer.booleanDeserializer(), "is_partial");
op.add(AbstractBuilder::isRunning, JsonpDeserializer.booleanDeserializer(), "is_running");
op.add(AbstractBuilder::took, JsonpDeserializer.longDeserializer(), "took");
op.add(AbstractBuilder::timedOut, JsonpDeserializer.booleanDeserializer(), "timed_out");
op.add(AbstractBuilder::hits, EqlHits.createEqlHitsDeserializer(tEventDeserializer), "hits");
}
}