Package co.elastic.clients.elasticsearch.esql

Class PutDatasetRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<PutDatasetRequest.Builder>

co.elastic.clients.elasticsearch.esql.PutDatasetRequest.Builder

All Implemented Interfaces:

WithJson<PutDatasetRequest.Builder>, ObjectBuilder<PutDatasetRequest>

Enclosing class:

PutDatasetRequest

public static class PutDatasetRequest.Builder
extends RequestBase.AbstractBuilder<PutDatasetRequest.Builder>
implements ObjectBuilder<PutDatasetRequest>

Builder for PutDatasetRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutDatasetRequest	build()	Builds a PutDatasetRequest.
final PutDatasetRequest.Builder	dataSource(String value)	Required - The name of the referenced data source.
final PutDatasetRequest.Builder	description(String value)	A free-text description of the dataset.
final PutDatasetRequest.Builder	mappings(DatasetMapping value)	User-declared mapping on the dataset definition
final PutDatasetRequest.Builder	mappings(Function<DatasetMapping.Builder,ObjectBuilder<DatasetMapping>> fn)	User-declared mapping on the dataset definition
final PutDatasetRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final PutDatasetRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final PutDatasetRequest.Builder	name(String value)	Required - The dataset name to create or update.
final PutDatasetRequest.Builder	resource(String value)	Required - The URI that identifies the data to read, resolved against the referenced data source.
protected PutDatasetRequest.Builder	self()
final PutDatasetRequest.Builder	settings(String key, JsonData value)	Format and parsing-specific settings that configure how the resource is read.
final PutDatasetRequest.Builder	settings(Map<String,JsonData> map)	Format and parsing-specific settings that configure how the resource is read.
final PutDatasetRequest.Builder	timeout(Time value)	The time to wait for the request to be completed.
final PutDatasetRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The time to wait for the request to be completed.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

dataSource

public final PutDatasetRequest.Builder dataSource(String value)

Required - The name of the referenced data source. The data source must already exist.

API name: data_source

description

public final PutDatasetRequest.Builder description(@Nullable
 String value)

A free-text description of the dataset.

API name: description

mappings

public final PutDatasetRequest.Builder mappings(@Nullable
 DatasetMapping value)

User-declared mapping on the dataset definition

API name: mappings

mappings

public final PutDatasetRequest.Builder mappings(Function<DatasetMapping.Builder,ObjectBuilder<DatasetMapping>> fn)

User-declared mapping on the dataset definition

API name: mappings

masterTimeout

public final PutDatasetRequest.Builder masterTimeout(@Nullable
 Time value)

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

public final PutDatasetRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

Period to wait for a connection to the master node.

API name: master_timeout

name

public final PutDatasetRequest.Builder name(String value)

Required - The dataset name to create or update.

API name: name

resource

public final PutDatasetRequest.Builder resource(String value)

Required - The URI that identifies the data to read, resolved against the referenced data source. It can include glob patterns. For example, a recursive pattern can match all Parquet files under the s3://logs-bucket/access prefix.

API name: resource

settings

public final PutDatasetRequest.Builder settings(Map<String,JsonData> map)

Format and parsing-specific settings that configure how the resource is read. Common keys include format, which explicitly selects a registered format, and partition_detection, which accepts auto, hive, template, or none. Additional keys depend on the format reader. Compression can be inferred from the resource URI.

API name: settings

Adds all entries of map to settings.

settings

public final PutDatasetRequest.Builder settings(String key,
 JsonData value)

Format and parsing-specific settings that configure how the resource is read. Common keys include format, which explicitly selects a registered format, and partition_detection, which accepts auto, hive, template, or none. Additional keys depend on the format reader. Compression can be inferred from the resource URI.

API name: settings

Adds an entry to settings.

timeout

public final PutDatasetRequest.Builder timeout(@Nullable
 Time value)

The time to wait for the request to be completed.

API name: timeout

timeout

public final PutDatasetRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The time to wait for the request to be completed.

API name: timeout

self

protected PutDatasetRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutDatasetRequest.Builder>

build

public PutDatasetRequest build()

Builds a PutDatasetRequest.

Specified by:

build in interface ObjectBuilder<PutDatasetRequest>

Throws:

NullPointerException - if some of the required fields are null.