co.elastic.clients.elasticsearch.transform.Source 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.transform;
import co.elastic.clients.elasticsearch._types.mapping.RuntimeField;
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.lang.String;
import java.util.List;
import java.util.Map;
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: transform._types.Source
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class Source implements JsonpSerializable {
private final List index;
@Nullable
private final Query query;
private final Map runtimeMappings;
// ---------------------------------------------------------------------------------------------
private Source(Builder builder) {
this.index = ApiTypeHelper.unmodifiableRequired(builder.index, this, "index");
this.query = builder.query;
this.runtimeMappings = ApiTypeHelper.unmodifiable(builder.runtimeMappings);
}
public static Source of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The source indices for the transform. It can be a single index, an
* index pattern (for example, "my-index-*""
), an
* array of indices (for example,
* ["my-index-000001", "my-index-000002"]
), or
* an array of index patterns (for example,
* ["my-index-*", "my-other-index-*"]
. For
* remote indices use the syntax
* "remote_name:index_name"
. If any indices are in remote
* clusters then the master node and at least one transform node must have the
* remote_cluster_client
node role.
*
* API name: {@code index}
*/
public final List index() {
return this.index;
}
/**
* A query clause that retrieves a subset of data from the source index.
*
* API name: {@code query}
*/
@Nullable
public final Query query() {
return this.query;
}
/**
* Definitions of search-time runtime fields that can be used by the transform.
* For search runtime fields all data nodes, including remote nodes, must be
* 7.12 or later.
*
* API name: {@code runtime_mappings}
*/
public final Map runtimeMappings() {
return this.runtimeMappings;
}
/**
* 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 (ApiTypeHelper.isDefined(this.index)) {
generator.writeKey("index");
generator.writeStartArray();
for (String item0 : this.index) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.query != null) {
generator.writeKey("query");
this.query.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.runtimeMappings)) {
generator.writeKey("runtime_mappings");
generator.writeStartObject();
for (Map.Entry item0 : this.runtimeMappings.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link Source}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder