Package co.elastic.clients.elasticsearch.esql

Class PutDataSourceRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.esql.PutDataSourceRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PutDataSourceRequest
extends RequestBase
implements JsonpSerializable

Create or update an ES|QL data source.

Creates or replaces a named, type-specific data source configuration for ES|QL data federation. Datasets reference data source configurations to access external data. Names must be lowercase and follow index or alias naming rules.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutDataSourceRequest.Builder	Builder for PutDataSourceRequest.

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PutDataSourceRequest>	_DESERIALIZER	Json deserializer for PutDataSourceRequest
static final Endpoint<PutDataSourceRequest,PutDataSourceResponse,ErrorResponse>	_ENDPOINT	Endpoint "esql.put_data_source".

Method Summary

Modifier and Type	Method	Description
final String	description()	A free-text description of the data source.
final Time	masterTimeout()	Period to wait for a connection to the master node.
final String	name()	Required - The data source name to create or update.
static PutDataSourceRequest	of(Function<PutDataSourceRequest.Builder,ObjectBuilder<PutDataSourceRequest>> fn)
PutDataSourceRequest.Builder	rebuild()
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
final Map<String,JsonData>	settings()	Type-specific connection and authentication settings.
protected static void	setupPutDataSourceRequestDeserializer(ObjectDeserializer<PutDataSourceRequest.Builder> op)
final Time	timeout()	The time to wait for the request to be completed.
final String	type()	Required - The data source type.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutDataSourceRequest> _DESERIALIZER

Json deserializer for PutDataSourceRequest

_ENDPOINT

public static final Endpoint<PutDataSourceRequest,PutDataSourceResponse,ErrorResponse> _ENDPOINT

Endpoint "esql.put_data_source".

Method Details

of

public static PutDataSourceRequest of(Function<PutDataSourceRequest.Builder,ObjectBuilder<PutDataSourceRequest>> fn)

description

@Nullable
public final String description()

A free-text description of the data source.

API name: description

masterTimeout

@Nullable
public final Time masterTimeout()

Period to wait for a connection to the master node.

API name: master_timeout

name

public final String name()

Required - The data source name to create or update.

API name: name

settings

public final Map<String,JsonData> settings()

Type-specific connection and authentication settings. For s3, connection settings include region and endpoint. Authentication settings include auth and the credentials required by the selected authentication method.

API name: settings

timeout

@Nullable
public final Time timeout()

The time to wait for the request to be completed.

API name: timeout

type

public final String type()

Required - The data source type. Currently, s3 is supported. The value must be lowercase and contain no whitespace.

API name: type

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

rebuild

public PutDataSourceRequest.Builder rebuild()

Returns:

New PutDataSourceRequest.Builder initialized with field values of this instance

setupPutDataSourceRequestDeserializer

protected static void setupPutDataSourceRequestDeserializer(ObjectDeserializer<PutDataSourceRequest.Builder> op)