co.elastic.clients.elasticsearch.ml.DataframeAnalyticsSummary 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.ml;
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.Integer;
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: ml._types.DataframeAnalyticsSummary
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataframeAnalyticsSummary implements JsonpSerializable {
@Nullable
private final Boolean allowLazyStart;
private final DataframeAnalysis analysis;
@Nullable
private final DataframeAnalysisAnalyzedFields analyzedFields;
@Nullable
private final DataframeAnalyticsAuthorization authorization;
@Nullable
private final Long createTime;
@Nullable
private final String description;
private final DataframeAnalyticsDestination dest;
private final String id;
@Nullable
private final Integer maxNumThreads;
@Nullable
private final String modelMemoryLimit;
private final DataframeAnalyticsSource source;
@Nullable
private final String version;
// ---------------------------------------------------------------------------------------------
private DataframeAnalyticsSummary(Builder builder) {
this.allowLazyStart = builder.allowLazyStart;
this.analysis = ApiTypeHelper.requireNonNull(builder.analysis, this, "analysis");
this.analyzedFields = builder.analyzedFields;
this.authorization = builder.authorization;
this.createTime = builder.createTime;
this.description = builder.description;
this.dest = ApiTypeHelper.requireNonNull(builder.dest, this, "dest");
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.maxNumThreads = builder.maxNumThreads;
this.modelMemoryLimit = builder.modelMemoryLimit;
this.source = ApiTypeHelper.requireNonNull(builder.source, this, "source");
this.version = builder.version;
}
public static DataframeAnalyticsSummary of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* API name: {@code allow_lazy_start}
*/
@Nullable
public final Boolean allowLazyStart() {
return this.allowLazyStart;
}
/**
* Required - API name: {@code analysis}
*/
public final DataframeAnalysis analysis() {
return this.analysis;
}
/**
* API name: {@code analyzed_fields}
*/
@Nullable
public final DataframeAnalysisAnalyzedFields analyzedFields() {
return this.analyzedFields;
}
/**
* The security privileges that the job uses to run its queries. If Elastic
* Stack security features were disabled at the time of the most recent update
* to the job, this property is omitted.
*
* API name: {@code authorization}
*/
@Nullable
public final DataframeAnalyticsAuthorization authorization() {
return this.authorization;
}
/**
* API name: {@code create_time}
*/
@Nullable
public final Long createTime() {
return this.createTime;
}
/**
* API name: {@code description}
*/
@Nullable
public final String description() {
return this.description;
}
/**
* Required - API name: {@code dest}
*/
public final DataframeAnalyticsDestination dest() {
return this.dest;
}
/**
* Required - API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* API name: {@code max_num_threads}
*/
@Nullable
public final Integer maxNumThreads() {
return this.maxNumThreads;
}
/**
* API name: {@code model_memory_limit}
*/
@Nullable
public final String modelMemoryLimit() {
return this.modelMemoryLimit;
}
/**
* Required - API name: {@code source}
*/
public final DataframeAnalyticsSource source() {
return this.source;
}
/**
* API name: {@code version}
*/
@Nullable
public final String version() {
return this.version;
}
/**
* 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.allowLazyStart != null) {
generator.writeKey("allow_lazy_start");
generator.write(this.allowLazyStart);
}
generator.writeKey("analysis");
this.analysis.serialize(generator, mapper);
if (this.analyzedFields != null) {
generator.writeKey("analyzed_fields");
this.analyzedFields.serialize(generator, mapper);
}
if (this.authorization != null) {
generator.writeKey("authorization");
this.authorization.serialize(generator, mapper);
}
if (this.createTime != null) {
generator.writeKey("create_time");
generator.write(this.createTime);
}
if (this.description != null) {
generator.writeKey("description");
generator.write(this.description);
}
generator.writeKey("dest");
this.dest.serialize(generator, mapper);
generator.writeKey("id");
generator.write(this.id);
if (this.maxNumThreads != null) {
generator.writeKey("max_num_threads");
generator.write(this.maxNumThreads);
}
if (this.modelMemoryLimit != null) {
generator.writeKey("model_memory_limit");
generator.write(this.modelMemoryLimit);
}
generator.writeKey("source");
this.source.serialize(generator, mapper);
if (this.version != null) {
generator.writeKey("version");
generator.write(this.version);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataframeAnalyticsSummary}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private Boolean allowLazyStart;
private DataframeAnalysis analysis;
@Nullable
private DataframeAnalysisAnalyzedFields analyzedFields;
@Nullable
private DataframeAnalyticsAuthorization authorization;
@Nullable
private Long createTime;
@Nullable
private String description;
private DataframeAnalyticsDestination dest;
private String id;
@Nullable
private Integer maxNumThreads;
@Nullable
private String modelMemoryLimit;
private DataframeAnalyticsSource source;
@Nullable
private String version;
/**
* API name: {@code allow_lazy_start}
*/
public final Builder allowLazyStart(@Nullable Boolean value) {
this.allowLazyStart = value;
return this;
}
/**
* Required - API name: {@code analysis}
*/
public final Builder analysis(DataframeAnalysis value) {
this.analysis = value;
return this;
}
/**
* Required - API name: {@code analysis}
*/
public final Builder analysis(Function> fn) {
return this.analysis(fn.apply(new DataframeAnalysis.Builder()).build());
}
/**
* API name: {@code analyzed_fields}
*/
public final Builder analyzedFields(@Nullable DataframeAnalysisAnalyzedFields value) {
this.analyzedFields = value;
return this;
}
/**
* API name: {@code analyzed_fields}
*/
public final Builder analyzedFields(
Function> fn) {
return this.analyzedFields(fn.apply(new DataframeAnalysisAnalyzedFields.Builder()).build());
}
/**
* The security privileges that the job uses to run its queries. If Elastic
* Stack security features were disabled at the time of the most recent update
* to the job, this property is omitted.
*
* API name: {@code authorization}
*/
public final Builder authorization(@Nullable DataframeAnalyticsAuthorization value) {
this.authorization = value;
return this;
}
/**
* The security privileges that the job uses to run its queries. If Elastic
* Stack security features were disabled at the time of the most recent update
* to the job, this property is omitted.
*
* API name: {@code authorization}
*/
public final Builder authorization(
Function> fn) {
return this.authorization(fn.apply(new DataframeAnalyticsAuthorization.Builder()).build());
}
/**
* API name: {@code create_time}
*/
public final Builder createTime(@Nullable Long value) {
this.createTime = value;
return this;
}
/**
* API name: {@code description}
*/
public final Builder description(@Nullable String value) {
this.description = value;
return this;
}
/**
* Required - API name: {@code dest}
*/
public final Builder dest(DataframeAnalyticsDestination value) {
this.dest = value;
return this;
}
/**
* Required - API name: {@code dest}
*/
public final Builder dest(
Function> fn) {
return this.dest(fn.apply(new DataframeAnalyticsDestination.Builder()).build());
}
/**
* Required - API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* API name: {@code max_num_threads}
*/
public final Builder maxNumThreads(@Nullable Integer value) {
this.maxNumThreads = value;
return this;
}
/**
* API name: {@code model_memory_limit}
*/
public final Builder modelMemoryLimit(@Nullable String value) {
this.modelMemoryLimit = value;
return this;
}
/**
* Required - API name: {@code source}
*/
public final Builder source(DataframeAnalyticsSource value) {
this.source = value;
return this;
}
/**
* Required - API name: {@code source}
*/
public final Builder source(
Function> fn) {
return this.source(fn.apply(new DataframeAnalyticsSource.Builder()).build());
}
/**
* API name: {@code version}
*/
public final Builder version(@Nullable String value) {
this.version = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataframeAnalyticsSummary}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataframeAnalyticsSummary build() {
_checkSingleUse();
return new DataframeAnalyticsSummary(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataframeAnalyticsSummary}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DataframeAnalyticsSummary::setupDataframeAnalyticsSummaryDeserializer);
protected static void setupDataframeAnalyticsSummaryDeserializer(
ObjectDeserializer op) {
op.add(Builder::allowLazyStart, JsonpDeserializer.booleanDeserializer(), "allow_lazy_start");
op.add(Builder::analysis, DataframeAnalysis._DESERIALIZER, "analysis");
op.add(Builder::analyzedFields, DataframeAnalysisAnalyzedFields._DESERIALIZER, "analyzed_fields");
op.add(Builder::authorization, DataframeAnalyticsAuthorization._DESERIALIZER, "authorization");
op.add(Builder::createTime, JsonpDeserializer.longDeserializer(), "create_time");
op.add(Builder::description, JsonpDeserializer.stringDeserializer(), "description");
op.add(Builder::dest, DataframeAnalyticsDestination._DESERIALIZER, "dest");
op.add(Builder::id, JsonpDeserializer.stringDeserializer(), "id");
op.add(Builder::maxNumThreads, JsonpDeserializer.integerDeserializer(), "max_num_threads");
op.add(Builder::modelMemoryLimit, JsonpDeserializer.stringDeserializer(), "model_memory_limit");
op.add(Builder::source, DataframeAnalyticsSource._DESERIALIZER, "source");
op.add(Builder::version, JsonpDeserializer.stringDeserializer(), "version");
}
}