Package org.opensearch.client.opensearch.snapshot

Class GetSnapshotRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch.snapshot.GetSnapshotRequest
All Implemented Interfaces:
ToCopyableBuilder<GetSnapshotRequest.Builder,GetSnapshotRequest>
@Generated("org.opensearch.client.codegen.CodeGenerator") public final class GetSnapshotRequest extends RequestBase implements ToCopyableBuilder<GetSnapshotRequest.Builder,GetSnapshotRequest>
Returns information about a snapshot.

  • Field Details

  • Method Details

    • of

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

    • clusterManagerTimeout

      @Nullable public final Time clusterManagerTimeout()
      The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.

      API name: cluster_manager_timeout

    • ignoreUnavailable

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

      API name: ignore_unavailable

    • masterTimeout

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

      API name: master_timeout

    • repository

      @Nonnull public final String repository()
      Required - A comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported.

      API name: repository

    • snapshot

      @Nonnull public final List<String> snapshot()
      Required -

      A comma-separated list of snapshot names to retrieve. Also accepts wildcard expressions. (*).

      • 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 Boolean verbose()
      When true, returns additional information about each snapshot such as the version of OpenSearch which took the snapshot, the start and end times of the snapshot, and the number of shards contained in the snapshot.

      API name: verbose

    • toBuilder

      @Nonnull public GetSnapshotRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetSnapshotRequest.Builder,GetSnapshotRequest>
      Returns:
      a new builder instance.

    • builder

      @Nonnull public static GetSnapshotRequest.Builder builder()

    • applyQueryParameters

      protected void applyQueryParameters(@Nonnull Map<String,String> params)
      Overrides:
      applyQueryParameters in class RequestBase

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object