Package co.elastic.clients.elasticsearch.snapshot

Class GetSnapshotResponse.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<GetSnapshotResponse.Builder>

co.elastic.clients.elasticsearch.snapshot.GetSnapshotResponse.Builder

All Implemented Interfaces:

WithJson<GetSnapshotResponse.Builder>, ObjectBuilder<GetSnapshotResponse>

Enclosing class:

GetSnapshotResponse

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

Builder for GetSnapshotResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetSnapshotResponse	build()	Builds a GetSnapshotResponse.
final GetSnapshotResponse.Builder	next(String value)	If the request contained a size limit and there might be more results, a next field will be added to the response.
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.
final GetSnapshotResponse.Builder	responses(SnapshotResponseItem value, SnapshotResponseItem... values)	API name: responses
final GetSnapshotResponse.Builder	responses(Function<SnapshotResponseItem.Builder,ObjectBuilder<SnapshotResponseItem>> fn)	API name: responses
final GetSnapshotResponse.Builder	responses(List<SnapshotResponseItem> list)	API name: responses
protected GetSnapshotResponse.Builder	self()
final GetSnapshotResponse.Builder	snapshots(SnapshotInfo value, SnapshotInfo... values)	API name: snapshots
final GetSnapshotResponse.Builder	snapshots(Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)	API name: snapshots
final GetSnapshotResponse.Builder	snapshots(List<SnapshotInfo> list)	API name: snapshots
final GetSnapshotResponse.Builder	total(int value)	Required - The total number of snapshots that match the request when ignoring the size limit or after query parameter.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

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

total

public final GetSnapshotResponse.Builder total(int value)

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

API name: total

next

public final GetSnapshotResponse.Builder next(@Nullable
 String value)

If the request contained a size limit and there might be more results, a next field will be added to the response. It can be used as the after query parameter to fetch additional results.

API name: next

responses

public final GetSnapshotResponse.Builder responses(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(Function<SnapshotResponseItem.Builder,ObjectBuilder<SnapshotResponseItem>> fn)

API name: responses

Adds a value to responses using a builder lambda.

snapshots

public final GetSnapshotResponse.Builder snapshots(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(Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)

API name: snapshots

Adds a value to snapshots using a builder lambda.

self

protected GetSnapshotResponse.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<GetSnapshotResponse.Builder>

build

public GetSnapshotResponse build()

Builds a GetSnapshotResponse.

Specified by:

build in interface ObjectBuilder<GetSnapshotResponse>

Throws:

NullPointerException - if some of the required fields are null.