All Downloads are FREE. Search and download functionalities are using the official Maven repository.

co.elastic.clients.elasticsearch.cluster.GetClusterSettingsRequest Maven / Gradle / Ivy

There is a newer version: 8.17.0
Show newest version
/*
 * 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.cluster;

import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ObjectBuilder;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.util.Collections;
import java.util.HashMap;
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: cluster.get_settings.Request

/**
 * Returns cluster-wide settings. By default, it returns only settings that have
 * been explicitly defined.
 * 
 * @see API
 *      specification
 */

public class GetClusterSettingsRequest extends RequestBase {
	@Nullable
	private final Boolean flatSettings;

	@Nullable
	private final Boolean includeDefaults;

	@Nullable
	private final Time masterTimeout;

	@Nullable
	private final Time timeout;

	// ---------------------------------------------------------------------------------------------

	private GetClusterSettingsRequest(Builder builder) {

		this.flatSettings = builder.flatSettings;
		this.includeDefaults = builder.includeDefaults;
		this.masterTimeout = builder.masterTimeout;
		this.timeout = builder.timeout;

	}

	public static GetClusterSettingsRequest of(Function> fn) {
		return fn.apply(new Builder()).build();
	}

	/**
	 * If true, returns settings in flat format.
	 * 

* API name: {@code flat_settings} */ @Nullable public final Boolean flatSettings() { return this.flatSettings; } /** * If true, returns default cluster settings from the local node. *

* API name: {@code include_defaults} */ @Nullable public final Boolean includeDefaults() { return this.includeDefaults; } /** * Period to wait for a connection to the master node. If no response is * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ @Nullable public final Time masterTimeout() { return this.masterTimeout; } /** * Period to wait for a response. If no response is received before the timeout * expires, the request fails and returns an error. *

* API name: {@code timeout} */ @Nullable public final Time timeout() { return this.timeout; } // --------------------------------------------------------------------------------------------- /** * Builder for {@link GetClusterSettingsRequest}. */ public static class Builder extends RequestBase.AbstractBuilder implements ObjectBuilder { @Nullable private Boolean flatSettings; @Nullable private Boolean includeDefaults; @Nullable private Time masterTimeout; @Nullable private Time timeout; /** * If true, returns settings in flat format. *

* API name: {@code flat_settings} */ public final Builder flatSettings(@Nullable Boolean value) { this.flatSettings = value; return this; } /** * If true, returns default cluster settings from the local node. *

* API name: {@code include_defaults} */ public final Builder includeDefaults(@Nullable Boolean value) { this.includeDefaults = value; return this; } /** * Period to wait for a connection to the master node. If no response is * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ public final Builder masterTimeout(@Nullable Time value) { this.masterTimeout = value; return this; } /** * Period to wait for a connection to the master node. If no response is * received before the timeout expires, the request fails and returns an error. *

* API name: {@code master_timeout} */ public final Builder masterTimeout(Function> fn) { return this.masterTimeout(fn.apply(new Time.Builder()).build()); } /** * Period to wait for a response. If no response is received before the timeout * expires, the request fails and returns an error. *

* API name: {@code timeout} */ public final Builder timeout(@Nullable Time value) { this.timeout = value; return this; } /** * Period to wait for a response. If no response is received before the timeout * expires, the request fails and returns an error. *

* API name: {@code timeout} */ public final Builder timeout(Function> fn) { return this.timeout(fn.apply(new Time.Builder()).build()); } @Override protected Builder self() { return this; } /** * Builds a {@link GetClusterSettingsRequest}. * * @throws NullPointerException * if some of the required fields are null. */ public GetClusterSettingsRequest build() { _checkSingleUse(); return new GetClusterSettingsRequest(this); } } // --------------------------------------------------------------------------------------------- /** * Endpoint "{@code cluster.get_settings}". */ public static final Endpoint _ENDPOINT = new SimpleEndpoint<>( "es/cluster.get_settings", // Request method request -> { return "GET"; }, // Request path request -> { return "/_cluster/settings"; }, // Path parameters request -> { return Collections.emptyMap(); }, // Request parameters request -> { Map params = new HashMap<>(); if (request.masterTimeout != null) { params.put("master_timeout", request.masterTimeout._toJsonString()); } if (request.flatSettings != null) { params.put("flat_settings", String.valueOf(request.flatSettings)); } if (request.includeDefaults != null) { params.put("include_defaults", String.valueOf(request.includeDefaults)); } if (request.timeout != null) { params.put("timeout", request.timeout._toJsonString()); } return params; }, SimpleEndpoint.emptyMap(), false, GetClusterSettingsResponse._DESERIALIZER); }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy