Package org.opensearch.client.opensearch.snapshot

Class GetSnapshotResponse.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.snapshot.GetSnapshotResponse.Builder

All Implemented Interfaces:

ObjectBuilder<GetSnapshotResponse>

Enclosing class:

GetSnapshotResponse

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

Builder for GetSnapshotResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetSnapshotResponse	build()	Builds a GetSnapshotResponse.
GetSnapshotResponse.Builder	remaining(int value)	Required - The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.
GetSnapshotResponse.Builder	responses(java.util.function.Function<SnapshotResponseItem.Builder,ObjectBuilder<SnapshotResponseItem>> fn)	API name: responses
GetSnapshotResponse.Builder	responses(java.util.List<SnapshotResponseItem> list)	API name: responses
GetSnapshotResponse.Builder	responses(SnapshotResponseItem value, SnapshotResponseItem... values)	API name: responses
GetSnapshotResponse.Builder	snapshots(java.util.function.Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)	API name: snapshots
GetSnapshotResponse.Builder	snapshots(java.util.List<SnapshotInfo> list)	API name: snapshots
GetSnapshotResponse.Builder	snapshots(SnapshotInfo value, SnapshotInfo... values)	API name: snapshots
GetSnapshotResponse.Builder	total(int value)	Required - The total number of snapshots that match the request when ignoring size limit or after query parameter.

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

responses

public final GetSnapshotResponse.Builder responses(java.util.List<SnapshotResponseItem> list)

API name: responses

Adds all elements of list to responses.

responses

public final GetSnapshotResponse.Builder responses(SnapshotResponseItem value,
                                                   SnapshotResponseItem... values)

API name: responses

Adds one or more values to responses.

responses

public final GetSnapshotResponse.Builder responses(java.util.function.Function<SnapshotResponseItem.Builder,ObjectBuilder<SnapshotResponseItem>> fn)

API name: responses

Adds a value to responses using a builder lambda.

snapshots

public final GetSnapshotResponse.Builder snapshots(java.util.List<SnapshotInfo> list)

API name: snapshots

Adds all elements of list to snapshots.

snapshots

public final GetSnapshotResponse.Builder snapshots(SnapshotInfo value,
                                                   SnapshotInfo... values)

API name: snapshots

Adds one or more values to snapshots.

snapshots

public final GetSnapshotResponse.Builder snapshots(java.util.function.Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)

API name: snapshots

Adds a value to snapshots using a builder lambda.

total

public final GetSnapshotResponse.Builder total(int value)

Required - The total number of snapshots that match the request when ignoring size limit or after query parameter.

API name: total

remaining

public final GetSnapshotResponse.Builder remaining(int value)

Required - The number of remaining snapshots that were not returned due to size limits and that can be fetched by additional requests using the next field value.

API name: remaining

build

public GetSnapshotResponse build()

Builds a GetSnapshotResponse.

Specified by:

build in interface ObjectBuilder<GetSnapshotResponse>

Throws:

java.lang.NullPointerException - if some of the required fields are null.