co.elastic.clients.elasticsearch.graph.Hop 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.graph;
import co.elastic.clients.elasticsearch._types.query_dsl.Query;
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.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: graph._types.Hop
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class Hop implements JsonpSerializable {
@Nullable
private final Hop connections;
private final Query query;
private final List vertices;
// ---------------------------------------------------------------------------------------------
private Hop(Builder builder) {
this.connections = builder.connections;
this.query = ApiTypeHelper.requireNonNull(builder.query, this, "query");
this.vertices = ApiTypeHelper.unmodifiableRequired(builder.vertices, this, "vertices");
}
public static Hop of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Specifies one or more fields from which you want to extract terms that are
* associated with the specified vertices.
*
* API name: {@code connections}
*/
@Nullable
public final Hop connections() {
return this.connections;
}
/**
* Required - An optional guiding query that constrains the Graph API as it
* explores connected terms.
*
* API name: {@code query}
*/
public final Query query() {
return this.query;
}
/**
* Required - Contains the fields you are interested in.
*
* API name: {@code vertices}
*/
public final List vertices() {
return this.vertices;
}
/**
* 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.connections != null) {
generator.writeKey("connections");
this.connections.serialize(generator, mapper);
}
generator.writeKey("query");
this.query.serialize(generator, mapper);
if (ApiTypeHelper.isDefined(this.vertices)) {
generator.writeKey("vertices");
generator.writeStartArray();
for (VertexDefinition item0 : this.vertices) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link Hop}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private Hop connections;
private Query query;
private List vertices;
/**
* Specifies one or more fields from which you want to extract terms that are
* associated with the specified vertices.
*
* API name: {@code connections}
*/
public final Builder connections(@Nullable Hop value) {
this.connections = value;
return this;
}
/**
* Specifies one or more fields from which you want to extract terms that are
* associated with the specified vertices.
*
* API name: {@code connections}
*/
public final Builder connections(Function> fn) {
return this.connections(fn.apply(new Hop.Builder()).build());
}
/**
* Required - An optional guiding query that constrains the Graph API as it
* explores connected terms.
*
* API name: {@code query}
*/
public final Builder query(Query value) {
this.query = value;
return this;
}
/**
* Required - An optional guiding query that constrains the Graph API as it
* explores connected terms.
*
* API name: {@code query}
*/
public final Builder query(Function> fn) {
return this.query(fn.apply(new Query.Builder()).build());
}
/**
* Required - Contains the fields you are interested in.
*
* API name: {@code vertices}
*
* Adds all elements of list to vertices.
*/
public final Builder vertices(List list) {
this.vertices = _listAddAll(this.vertices, list);
return this;
}
/**
* Required - Contains the fields you are interested in.
*
* API name: {@code vertices}
*
* Adds one or more values to vertices.
*/
public final Builder vertices(VertexDefinition value, VertexDefinition... values) {
this.vertices = _listAdd(this.vertices, value, values);
return this;
}
/**
* Required - Contains the fields you are interested in.
*
* API name: {@code vertices}
*
* Adds a value to vertices using a builder lambda.
*/
public final Builder vertices(Function> fn) {
return vertices(fn.apply(new VertexDefinition.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link Hop}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public Hop build() {
_checkSingleUse();
return new Hop(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link Hop}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
Hop::setupHopDeserializer);
protected static void setupHopDeserializer(ObjectDeserializer op) {
op.add(Builder::connections, Hop._DESERIALIZER, "connections");
op.add(Builder::query, Query._DESERIALIZER, "query");
op.add(Builder::vertices, JsonpDeserializer.arrayDeserializer(VertexDefinition._DESERIALIZER), "vertices");
}
}