Package co.elastic.clients.elasticsearch.snapshot

Class ReadOnlyUrlRepositorySettings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase.AbstractBuilder<ReadOnlyUrlRepositorySettings.Builder>

co.elastic.clients.elasticsearch.snapshot.ReadOnlyUrlRepositorySettings.Builder

All Implemented Interfaces:

WithJson<ReadOnlyUrlRepositorySettings.Builder>, ObjectBuilder<ReadOnlyUrlRepositorySettings>

Enclosing class:

ReadOnlyUrlRepositorySettings

public static class ReadOnlyUrlRepositorySettings.Builder
extends RepositorySettingsBase.AbstractBuilder<ReadOnlyUrlRepositorySettings.Builder>
implements ObjectBuilder<ReadOnlyUrlRepositorySettings>

Builder for ReadOnlyUrlRepositorySettings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ReadOnlyUrlRepositorySettings	build()	Builds a ReadOnlyUrlRepositorySettings.
final ReadOnlyUrlRepositorySettings.Builder	httpMaxRetries(Integer value)	The maximum number of retries for HTTP and HTTPS URLs.
final ReadOnlyUrlRepositorySettings.Builder	httpSocketTimeout(Time value)	The maximum wait time for data transfers over a connection.
final ReadOnlyUrlRepositorySettings.Builder	httpSocketTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)	The maximum wait time for data transfers over a connection.
final ReadOnlyUrlRepositorySettings.Builder	maxNumberOfSnapshots(Integer value)	The maximum number of snapshots the repository can contain.
protected ReadOnlyUrlRepositorySettings.Builder	self()
final ReadOnlyUrlRepositorySettings.Builder	url(String value)	Required - The URL location of the root of the shared filesystem repository.

Methods inherited from class co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase.AbstractBuilder

chunkSize, compress, maxRestoreBytesPerSec, maxSnapshotBytesPerSec

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

httpMaxRetries

public final ReadOnlyUrlRepositorySettings.Builder httpMaxRetries(@Nullable
 Integer value)

The maximum number of retries for HTTP and HTTPS URLs.

API name: http_max_retries

httpSocketTimeout

public final ReadOnlyUrlRepositorySettings.Builder httpSocketTimeout(@Nullable
 Time value)

The maximum wait time for data transfers over a connection.

API name: http_socket_timeout

httpSocketTimeout

public final ReadOnlyUrlRepositorySettings.Builder httpSocketTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)

The maximum wait time for data transfers over a connection.

API name: http_socket_timeout

maxNumberOfSnapshots

public final ReadOnlyUrlRepositorySettings.Builder maxNumberOfSnapshots(@Nullable
 Integer value)

The maximum number of snapshots the repository can contain. The default is Integer.MAX_VALUE, which is 2^31-1 or 2147483647.

API name: max_number_of_snapshots

url

public final ReadOnlyUrlRepositorySettings.Builder url(String value)

Required - The URL location of the root of the shared filesystem repository. The following protocols are supported:

• file
• ftp
• http
• https
• jar

URLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the repositories.url.allowed_urls cluster setting. This setting supports wildcards in the place of a host, path, query, or fragment in the URL.

URLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster. This location must be registered in the path.repo setting. You don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the path.repo setting.

API name: url

self

protected ReadOnlyUrlRepositorySettings.Builder self()

Specified by:

self in class RepositorySettingsBase.AbstractBuilder<ReadOnlyUrlRepositorySettings.Builder>

build

public ReadOnlyUrlRepositorySettings build()

Builds a ReadOnlyUrlRepositorySettings.

Specified by:

build in interface ObjectBuilder<ReadOnlyUrlRepositorySettings>

Throws:

NullPointerException - if some of the required fields are null.