Package co.elastic.clients.elasticsearch.snapshot

Class SourceOnlyRepositorySettingsForReadOnlyUrl

java.lang.Object

co.elastic.clients.elasticsearch.snapshot.SourceOnlyRepositorySettingsForReadOnlyUrl

All Implemented Interfaces:

SourceOnlyRepositorySettingsVariant, JsonpSerializable

@JsonpDeserializable
public class SourceOnlyRepositorySettingsForReadOnlyUrl
extends Object
implements SourceOnlyRepositorySettingsVariant, JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<SourceOnlyRepositorySettingsForReadOnlyUrl>	_DESERIALIZER	Json deserializer for SourceOnlyRepositorySettingsForReadOnlyUrl

Method Summary

Modifier and Type	Method	Description
SourceOnlyRepositorySettings.Kind	_sourceOnlyRepositorySettingsKind()	SourceOnlyRepositorySettings variant kind.
final Integer	httpMaxRetries()	The maximum number of retries for HTTP and HTTPS URLs.
final Time	httpSocketTimeout()	The maximum wait time for data transfers over a connection.
final Integer	maxNumberOfSnapshots()	The maximum number of snapshots the repository can contain.
static SourceOnlyRepositorySettingsForReadOnlyUrl	of(Function<SourceOnlyRepositorySettingsForReadOnlyUrl.Builder,ObjectBuilder<SourceOnlyRepositorySettingsForReadOnlyUrl>> fn)
SourceOnlyRepositorySettingsForReadOnlyUrl.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)
protected static void	setupSourceOnlyRepositorySettingsForReadOnlyUrlDeserializer(ObjectDeserializer<SourceOnlyRepositorySettingsForReadOnlyUrl.Builder> op)
String	toString()
final String	url()	Required - The URL location of the root of the shared filesystem repository.

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.elasticsearch.snapshot.SourceOnlyRepositorySettingsVariant

_toSourceOnlyRepositorySettings

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SourceOnlyRepositorySettingsForReadOnlyUrl> _DESERIALIZER

Json deserializer for SourceOnlyRepositorySettingsForReadOnlyUrl

Method Details

of

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

_sourceOnlyRepositorySettingsKind

public SourceOnlyRepositorySettings.Kind _sourceOnlyRepositorySettingsKind()

SourceOnlyRepositorySettings variant kind.

Specified by:

_sourceOnlyRepositorySettingsKind in interface SourceOnlyRepositorySettingsVariant

httpMaxRetries

@Nullable
public final Integer httpMaxRetries()

The maximum number of retries for HTTP and HTTPS URLs.

API name: http_max_retries

httpSocketTimeout

@Nullable
public final Time httpSocketTimeout()

The maximum wait time for data transfers over a connection.

API name: http_socket_timeout

maxNumberOfSnapshots

@Nullable
public final Integer maxNumberOfSnapshots()

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 String url()

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

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)

toString

public String toString()

Overrides:

toString in class Object

rebuild

public SourceOnlyRepositorySettingsForReadOnlyUrl.Builder rebuild()

Returns:

New SourceOnlyRepositorySettingsForReadOnlyUrl.Builder initialized with field values of this instance

setupSourceOnlyRepositorySettingsForReadOnlyUrlDeserializer

protected static void setupSourceOnlyRepositorySettingsForReadOnlyUrlDeserializer(ObjectDeserializer<SourceOnlyRepositorySettingsForReadOnlyUrl.Builder> op)