org.elasticsearch.cluster.metadata.ComponentTemplate 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
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0 and the Server Side Public License, v 1; you may not use this file except
* in compliance with, at your election, the Elastic License 2.0 or the Server
* Side Public License, v 1.
*/
package org.elasticsearch.cluster.metadata;
import org.elasticsearch.cluster.AbstractDiffable;
import org.elasticsearch.cluster.Diff;
import org.elasticsearch.common.Strings;
import org.elasticsearch.common.io.stream.StreamInput;
import org.elasticsearch.common.io.stream.StreamOutput;
import org.elasticsearch.core.Nullable;
import org.elasticsearch.xcontent.ConstructingObjectParser;
import org.elasticsearch.xcontent.ParseField;
import org.elasticsearch.xcontent.ToXContentObject;
import org.elasticsearch.xcontent.XContentBuilder;
import org.elasticsearch.xcontent.XContentParser;
import java.io.IOException;
import java.util.Map;
import java.util.Objects;
/**
* A component template is a re-usable {@link Template} as well as metadata about the template. Each
* component template is expected to be valid on its own. For example, if a component template
* contains a field "foo", it's expected to contain all the necessary settings/mappings/etc for the
* "foo" field. These component templates make up the individual pieces composing an index template.
*/
public class ComponentTemplate extends AbstractDiffable implements ToXContentObject {
private static final ParseField TEMPLATE = new ParseField("template");
private static final ParseField VERSION = new ParseField("version");
private static final ParseField METADATA = new ParseField("_meta");
@SuppressWarnings("unchecked")
public static final ConstructingObjectParser PARSER = new ConstructingObjectParser<>(
"component_template",
false,
a -> new ComponentTemplate((Template) a[0], (Long) a[1], (Map) a[2])
);
static {
PARSER.declareObject(ConstructingObjectParser.constructorArg(), Template.PARSER, TEMPLATE);
PARSER.declareLong(ConstructingObjectParser.optionalConstructorArg(), VERSION);
PARSER.declareObject(ConstructingObjectParser.optionalConstructorArg(), (p, c) -> p.map(), METADATA);
}
private final Template template;
@Nullable
private final Long version;
@Nullable
private final Map metadata;
static Diff readComponentTemplateDiffFrom(StreamInput in) throws IOException {
return AbstractDiffable.readDiffFrom(ComponentTemplate::new, in);
}
public static ComponentTemplate parse(XContentParser parser) {
return PARSER.apply(parser, null);
}
public ComponentTemplate(Template template, @Nullable Long version, @Nullable Map metadata) {
this.template = template;
this.version = version;
this.metadata = metadata;
}
public ComponentTemplate(StreamInput in) throws IOException {
this.template = new Template(in);
this.version = in.readOptionalVLong();
if (in.readBoolean()) {
this.metadata = in.readMap();
} else {
this.metadata = null;
}
}
public Template template() {
return template;
}
@Nullable
public Long version() {
return version;
}
@Nullable
public Map metadata() {
return metadata;
}
@Override
public void writeTo(StreamOutput out) throws IOException {
this.template.writeTo(out);
out.writeOptionalVLong(this.version);
if (this.metadata == null) {
out.writeBoolean(false);
} else {
out.writeBoolean(true);
out.writeMap(this.metadata);
}
}
@Override
public int hashCode() {
return Objects.hash(template, version, metadata);
}
@Override
public boolean equals(Object obj) {
if (obj == null) {
return false;
}
if (obj.getClass() != getClass()) {
return false;
}
ComponentTemplate other = (ComponentTemplate) obj;
return Objects.equals(template, other.template)
&& Objects.equals(version, other.version)
&& Objects.equals(metadata, other.metadata);
}
@Override
public String toString() {
return Strings.toString(this);
}
@Override
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException {
builder.startObject();
builder.field(TEMPLATE.getPreferredName(), this.template, params);
if (this.version != null) {
builder.field(VERSION.getPreferredName(), this.version);
}
if (this.metadata != null) {
builder.field(METADATA.getPreferredName(), this.metadata);
}
builder.endObject();
return builder;
}
}