Package co.elastic.clients.elasticsearch.snapshot

Class GetResponse.Builder

java.lang.Object

co.elastic.clients.elasticsearch.snapshot.GetResponse.Builder

All Implemented Interfaces:

ObjectBuilder<GetResponse>

Enclosing class:

GetResponse

public static class GetResponse.Builder
extends java.lang.Object
implements ObjectBuilder<GetResponse>

Builder for GetResponse.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GetResponse.Builder	addResponses(SnapshotResponseItem value)	Add a value to responses(List), creating the list if needed.
GetResponse.Builder	addResponses(java.util.function.Function<SnapshotResponseItem.Builder,ObjectBuilder<SnapshotResponseItem>> fn)	Add a value to responses(List), creating the list if needed.
GetResponse.Builder	addSnapshots(SnapshotInfo value)	Add a value to snapshots(List), creating the list if needed.
GetResponse.Builder	addSnapshots(java.util.function.Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)	Add a value to snapshots(List), creating the list if needed.
GetResponse	build()	Builds a GetResponse.
GetResponse.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.
GetResponse.Builder	responses(SnapshotResponseItem... value)	API name: responses
GetResponse.Builder	responses(java.util.function.Function<SnapshotResponseItem.Builder,ObjectBuilder<SnapshotResponseItem>> fn)	Set responses(List) to a singleton list.
GetResponse.Builder	responses(java.util.List<SnapshotResponseItem> value)	API name: responses
GetResponse.Builder	snapshots(SnapshotInfo... value)	API name: snapshots
GetResponse.Builder	snapshots(java.util.function.Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)	Set snapshots(List) to a singleton list.
GetResponse.Builder	snapshots(java.util.List<SnapshotInfo> value)	API name: snapshots
GetResponse.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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

responses

public GetResponse.Builder responses(@Nullable
java.util.List<SnapshotResponseItem> value)

API name: responses

responses

public GetResponse.Builder responses(SnapshotResponseItem... value)

API name: responses

addResponses

public GetResponse.Builder addResponses(SnapshotResponseItem value)

Add a value to responses(List), creating the list if needed.

responses

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

Set responses(List) to a singleton list.

addResponses

public GetResponse.Builder addResponses(java.util.function.Function<SnapshotResponseItem.Builder,ObjectBuilder<SnapshotResponseItem>> fn)

Add a value to responses(List), creating the list if needed.

snapshots

public GetResponse.Builder snapshots(@Nullable
java.util.List<SnapshotInfo> value)

API name: snapshots

snapshots

public GetResponse.Builder snapshots(SnapshotInfo... value)

API name: snapshots

addSnapshots

public GetResponse.Builder addSnapshots(SnapshotInfo value)

Add a value to snapshots(List), creating the list if needed.

snapshots

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

Set snapshots(List) to a singleton list.

addSnapshots

public GetResponse.Builder addSnapshots(java.util.function.Function<SnapshotInfo.Builder,ObjectBuilder<SnapshotInfo>> fn)

Add a value to snapshots(List), creating the list if needed.

total

public GetResponse.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 GetResponse.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 GetResponse build()

Builds a GetResponse.

Specified by:

build in interface ObjectBuilder<GetResponse>

Throws:

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