SnapshotsRequest.Builder (java-client 2.1.0 API)

java.lang.Object
- org.opensearch.client.util.ObjectBuilderBase
- - org.opensearch.client.opensearch.cat.SnapshotsRequest.Builder

All Implemented Interfaces:: ObjectBuilder<SnapshotsRequest>

Enclosing class:: SnapshotsRequest

public static class SnapshotsRequest.Builder
extends ObjectBuilderBase
implements ObjectBuilder<SnapshotsRequest>

Builder for SnapshotsRequest.

Constructor Summary

Constructors
Constructor Description

Builder()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SnapshotsRequest`	`build()`	Builds a `SnapshotsRequest`.
`SnapshotsRequest.Builder`	`ignoreUnavailable(java.lang.Boolean value)`	Set to true to ignore unavailable snapshots
`SnapshotsRequest.Builder`	`repository(java.lang.String value, java.lang.String... values)`	Name of repository from which to fetch the snapshot information
`SnapshotsRequest.Builder`	`repository(java.util.List<java.lang.String> list)`	Name of repository from which to fetch the snapshot information

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - ignoreUnavailable
```
public final SnapshotsRequest.Builder ignoreUnavailable(@Nullable
                                                        java.lang.Boolean value)
```
    Set to true to ignore unavailable snapshots
    API name: ignore_unavailable
  - repository
```
public final SnapshotsRequest.Builder repository(java.util.List<java.lang.String> list)
```
    Name of repository from which to fetch the snapshot information
    API name: repository
    Adds all elements of list to repository.
  - repository
```
public final SnapshotsRequest.Builder repository(java.lang.String value,
                                                 java.lang.String... values)
```
    Name of repository from which to fetch the snapshot information
    API name: repository
    Adds one or more values to repository.
  - build
```
public SnapshotsRequest build()
```
    Builds a SnapshotsRequest.
    
    Specified by:
    
    build in interface ObjectBuilder<SnapshotsRequest>
    
    Throws:
    
    java.lang.NullPointerException - if some of the required fields are null.