
co.elastic.clients.elasticsearch.nodes.CgroupMemory 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.nodes;
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.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
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: nodes._types.CgroupMemory
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class CgroupMemory implements JsonpSerializable {
@Nullable
private final String controlGroup;
@Nullable
private final String limitInBytes;
@Nullable
private final String usageInBytes;
// ---------------------------------------------------------------------------------------------
private CgroupMemory(Builder builder) {
this.controlGroup = builder.controlGroup;
this.limitInBytes = builder.limitInBytes;
this.usageInBytes = builder.usageInBytes;
}
public static CgroupMemory of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* The memory
control group to which the Elasticsearch process
* belongs.
*
* API name: {@code control_group}
*/
@Nullable
public final String controlGroup() {
return this.controlGroup;
}
/**
* The maximum amount of user memory (including file cache) allowed for all
* tasks in the same cgroup as the Elasticsearch process. This value can be too
* big to store in a long
, so is returned as a string so that the
* value returned can exactly match what the underlying operating system
* interface returns. Any value that is too large to parse into a
* long
almost certainly means no limit has been set for the
* cgroup.
*
* API name: {@code limit_in_bytes}
*/
@Nullable
public final String limitInBytes() {
return this.limitInBytes;
}
/**
* The total current memory usage by processes in the cgroup, in bytes, by all
* tasks in the same cgroup as the Elasticsearch process. This value is stored
* as a string for consistency with limit_in_bytes
.
*
* API name: {@code usage_in_bytes}
*/
@Nullable
public final String usageInBytes() {
return this.usageInBytes;
}
/**
* 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.controlGroup != null) {
generator.writeKey("control_group");
generator.write(this.controlGroup);
}
if (this.limitInBytes != null) {
generator.writeKey("limit_in_bytes");
generator.write(this.limitInBytes);
}
if (this.usageInBytes != null) {
generator.writeKey("usage_in_bytes");
generator.write(this.usageInBytes);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link CgroupMemory}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private String controlGroup;
@Nullable
private String limitInBytes;
@Nullable
private String usageInBytes;
/**
* The memory
control group to which the Elasticsearch process
* belongs.
*
* API name: {@code control_group}
*/
public final Builder controlGroup(@Nullable String value) {
this.controlGroup = value;
return this;
}
/**
* The maximum amount of user memory (including file cache) allowed for all
* tasks in the same cgroup as the Elasticsearch process. This value can be too
* big to store in a long
, so is returned as a string so that the
* value returned can exactly match what the underlying operating system
* interface returns. Any value that is too large to parse into a
* long
almost certainly means no limit has been set for the
* cgroup.
*
* API name: {@code limit_in_bytes}
*/
public final Builder limitInBytes(@Nullable String value) {
this.limitInBytes = value;
return this;
}
/**
* The total current memory usage by processes in the cgroup, in bytes, by all
* tasks in the same cgroup as the Elasticsearch process. This value is stored
* as a string for consistency with limit_in_bytes
.
*
* API name: {@code usage_in_bytes}
*/
public final Builder usageInBytes(@Nullable String value) {
this.usageInBytes = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link CgroupMemory}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public CgroupMemory build() {
_checkSingleUse();
return new CgroupMemory(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link CgroupMemory}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
CgroupMemory::setupCgroupMemoryDeserializer);
protected static void setupCgroupMemoryDeserializer(ObjectDeserializer op) {
op.add(Builder::controlGroup, JsonpDeserializer.stringDeserializer(), "control_group");
op.add(Builder::limitInBytes, JsonpDeserializer.stringDeserializer(), "limit_in_bytes");
op.add(Builder::usageInBytes, JsonpDeserializer.stringDeserializer(), "usage_in_bytes");
}
}