Package co.elastic.clients.elasticsearch.snapshot

Class ReadOnlyUrlRepositorySettings

java.lang.Object
co.elastic.clients.elasticsearch.snapshot.RepositorySettingsBase
co.elastic.clients.elasticsearch.snapshot.ReadOnlyUrlRepositorySettings
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class ReadOnlyUrlRepositorySettings extends RepositorySettingsBase
See Also:

  • Field Details

  • Method Details

    • of

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

    • 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

    • serializeInternal

      protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Overrides:
      serializeInternal in class RepositorySettingsBase

    • setupReadOnlyUrlRepositorySettingsDeserializer

      protected static void setupReadOnlyUrlRepositorySettingsDeserializer(ObjectDeserializer<ReadOnlyUrlRepositorySettings.Builder> op)