Package org.opensearch.client.opensearch.snapshot

Class GetSnapshotRequest.Builder

java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.RequestBase.AbstractBuilder<GetSnapshotRequest.Builder>
org.opensearch.client.opensearch.snapshot.GetSnapshotRequest.Builder
All Implemented Interfaces:
CopyableBuilder<GetSnapshotRequest.Builder,GetSnapshotRequest>, MutableBuilder<GetSnapshotRequest.Builder,GetSnapshotRequest>, ObjectBuilder<GetSnapshotRequest>
Enclosing class:
GetSnapshotRequest
public static class GetSnapshotRequest.Builder extends RequestBase.AbstractBuilder<GetSnapshotRequest.Builder> implements CopyableBuilder<GetSnapshotRequest.Builder,GetSnapshotRequest>
Builder for GetSnapshotRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • copy

      @Nonnull public GetSnapshotRequest.Builder copy()
      Description copied from interface: CopyableBuilder
      Create a new builder CopyableBuilder that is a copy of this one.
      Specified by:
      copy in interface CopyableBuilder<GetSnapshotRequest.Builder,GetSnapshotRequest>
      Returns:
      a new builder instance.

    • self

      @Nonnull protected GetSnapshotRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<GetSnapshotRequest.Builder>

    • clusterManagerTimeout

      @Nonnull public final GetSnapshotRequest.Builder clusterManagerTimeout(@Nullable Time value)
      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

    • clusterManagerTimeout

      @Nonnull public final GetSnapshotRequest.Builder clusterManagerTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

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

      API name: ignore_unavailable

    • masterTimeout

      @Deprecated @Nonnull public final GetSnapshotRequest.Builder masterTimeout(@Nullable Time value)
      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

    • masterTimeout

      @Deprecated @Nonnull public final GetSnapshotRequest.Builder masterTimeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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 GetSnapshotRequest.Builder repository(String value)
      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 GetSnapshotRequest.Builder snapshot(List<String> list)
      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

      Adds all elements of list to snapshot.

    • snapshot

      @Nonnull public final GetSnapshotRequest.Builder snapshot(String value, String... values)
      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

      Adds one or more values to snapshot.

    • verbose

      @Nonnull public final GetSnapshotRequest.Builder verbose(@Nullable Boolean value)
      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. When false, returns only snapshot names and contained indexes. This is useful when the snapshots belong to a cloud-based repository, where each blob read is a cost or performance concern.

      API name: verbose

    • build

      @Nonnull public GetSnapshotRequest build()
      Builds a GetSnapshotRequest.
      Specified by:
      build in interface ObjectBuilder<GetSnapshotRequest>
      Throws:
      NullPointerException - if some of the required fields are null.