Package co.elastic.clients.elasticsearch.snapshot

Class GetSnapshotRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.snapshot.GetSnapshotRequest
public class GetSnapshotRequest
extends RequestBase
Returns information about a snapshot.
See Also:
API specification

  • Nested Class Summary

    Nested Classes
    Modifier and Type Class Description
    static class  GetSnapshotRequest.Builder
    Builder for GetSnapshotRequest.

    Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

    RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

  • Field Summary

    Fields
    Modifier and Type Field Description
    static Endpoint<GetSnapshotRequest,​GetSnapshotResponse,​ErrorResponse> _ENDPOINT
    Endpoint "snapshot.get".

  • Method Summary

    Modifier and Type Method Description
    java.lang.Boolean human()
    API name: human
    java.lang.Boolean ignoreUnavailable()
    If false, the request returns an error for any snapshots that are unavailable.
    java.lang.Boolean includeRepository()
    Whether to include the repository name in the snapshot info.
    java.lang.Boolean indexDetails()
    If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index.
    Time masterTimeout()
    Period to wait for a connection to the master node.
    static GetSnapshotRequest of​(java.util.function.Function<GetSnapshotRequest.Builder,​ObjectBuilder<GetSnapshotRequest>> fn)  
    java.lang.String repository()
    Required - Comma-separated list of snapshot repository names used to limit the request.
    java.util.List<java.lang.String> snapshot()
    Required - Comma-separated list of snapshot names to retrieve.
    java.lang.Boolean verbose()
    If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • of

      public static GetSnapshotRequest of​(java.util.function.Function<GetSnapshotRequest.Builder,​ObjectBuilder<GetSnapshotRequest>> fn)

    • human

      @Nullable public final java.lang.Boolean human()
      API name: human

    • ignoreUnavailable

      @Nullable public final java.lang.Boolean ignoreUnavailable()
      If false, the request returns an error for any snapshots that are unavailable.

      API name: ignore_unavailable

    • includeRepository

      @Nullable public final java.lang.Boolean includeRepository()
      Whether to include the repository name in the snapshot info. Defaults to true.

      API name: include_repository

    • indexDetails

      @Nullable public final java.lang.Boolean indexDetails()
      If true, returns additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. Defaults to false, meaning that this information is omitted.

      API name: index_details

    • masterTimeout

      @Nullable public final Time masterTimeout()
      Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.

      API name: master_timeout

    • repository

      public final java.lang.String repository()
      Required - Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

      API name: repository

    • snapshot

      public final java.util.List<java.lang.String> snapshot()
      Required - Comma-separated list of snapshot names to retrieve. Also accepts wildcards (*).
      • To get information about all snapshots in a registered repository, use a wildcard (*) or _all.
      • To get information about any snapshots that are currently running, use _current.

      API name: snapshot

    • verbose

      @Nullable public final java.lang.Boolean verbose()
      If true, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.

      API name: verbose