Package co.elastic.clients.elasticsearch.esql

Class PutDataSourceRequest.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

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

co.elastic.clients.elasticsearch.esql.PutDataSourceRequest.Builder

All Implemented Interfaces:

WithJson<PutDataSourceRequest.Builder>, ObjectBuilder<PutDataSourceRequest>

Enclosing class:

PutDataSourceRequest

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

Builder for PutDataSourceRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PutDataSourceRequest	build()	Builds a PutDataSourceRequest.
final PutDataSourceRequest.Builder	description(String value)	A free-text description of the data source.
final PutDataSourceRequest.Builder	masterTimeout(Time value)	Period to wait for a connection to the master node.
final PutDataSourceRequest.Builder	masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	Period to wait for a connection to the master node.
final PutDataSourceRequest.Builder	name(String value)	Required - The data source name to create or update.
protected PutDataSourceRequest.Builder	self()
final PutDataSourceRequest.Builder	settings(String key, JsonData value)	Type-specific connection and authentication settings.
final PutDataSourceRequest.Builder	settings(Map<String,JsonData> map)	Type-specific connection and authentication settings.
final PutDataSourceRequest.Builder	timeout(Time value)	The time to wait for the request to be completed.
final PutDataSourceRequest.Builder	timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The time to wait for the request to be completed.
final PutDataSourceRequest.Builder	type(String value)	Required - The data source type.

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

description

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

A free-text description of the data source.

API name: description

masterTimeout

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

Period to wait for a connection to the master node.

API name: master_timeout

masterTimeout

public final PutDataSourceRequest.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 PutDataSourceRequest.Builder name(String value)

Required - The data source name to create or update.

API name: name

settings

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

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

Adds all entries of map to settings.

settings

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

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

Adds an entry to settings.

timeout

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

The time to wait for the request to be completed.

API name: timeout

timeout

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

The time to wait for the request to be completed.

API name: timeout

type

public final PutDataSourceRequest.Builder type(String value)

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

API name: type

self

protected PutDataSourceRequest.Builder self()

Specified by:

self in class RequestBase.AbstractBuilder<PutDataSourceRequest.Builder>

build

public PutDataSourceRequest build()

Builds a PutDataSourceRequest.

Specified by:

build in interface ObjectBuilder<PutDataSourceRequest>

Throws:

NullPointerException - if some of the required fields are null.