Package co.elastic.clients.elasticsearch.snapshot

Class CreateRepositoryRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.snapshot.CreateRepositoryRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class CreateRepositoryRequest extends RequestBase implements JsonpSerializable
Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access.

Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used.

See Also:

  • Field Details

  • Method Details

    • of

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

    • masterTimeout

      @Nullable public final Time masterTimeout()
      The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to -1.

      API name: master_timeout

    • name

      public final String name()
      Required - The name of the snapshot repository to register or update.

      API name: repository

    • timeout

      @Nullable public final Time timeout()
      The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to -1.

      API name: timeout

    • verify

      @Nullable public final Boolean verify()
      If true, the request verifies the repository is functional on all master and data nodes in the cluster. If false, this verification is skipped. You can also perform this verification with the verify snapshot repository API.

      API name: verify

    • repository

      public final Repository repository()
      Required - Request body.

    • serialize

      public void serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this value to JSON.
      Specified by:
      serialize in interface JsonpSerializable

    • createCreateRepositoryRequestDeserializer

      protected static JsonpDeserializer<CreateRepositoryRequest> createCreateRepositoryRequestDeserializer()