Package org.elasticsearch.repositories

Class GetSnapshotInfoContext

java.lang.Object

org.elasticsearch.repositories.GetSnapshotInfoContext

All Implemented Interfaces:

ActionListener<SnapshotInfo>

public final class GetSnapshotInfoContext
extends Object
implements ActionListener<SnapshotInfo>

Describes the context of fetching one or more SnapshotInfo via Repository.getSnapshotInfo(GetSnapshotInfoContext).

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.action.ActionListener

ActionListener.Delegating<Response,DelegateResponse>, ActionListener.DelegatingActionListener<T>, ActionListener.DelegatingFailureActionListener<T,R>, ActionListener.MappedActionListener<Response,MappedResponse>, ActionListener.RunAfterActionListener<T>, ActionListener.RunBeforeActionListener<T>

Constructor Summary

Constructors

Constructor	Description
GetSnapshotInfoContext(Collection<SnapshotId> snapshotIds, boolean abortOnFailure, BooleanSupplier isCancelled, BiConsumer<GetSnapshotInfoContext,SnapshotInfo> consumer, ActionListener<Void> listener)

Method Summary

Modifier and Type	Method	Description
boolean	abortOnFailure()
boolean	done()
boolean	isCancelled()
void	onFailure(Exception e)	A failure caused by an exception at some phase of the task.
void	onResponse(SnapshotInfo snapshotInfo)	Handle action response.
List<SnapshotId>	snapshotIds()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.action.ActionListener

delegateFailure, delegateResponse, map

Constructor Details

GetSnapshotInfoContext

public GetSnapshotInfoContext(Collection<SnapshotId> snapshotIds,
 boolean abortOnFailure,
 BooleanSupplier isCancelled,
 BiConsumer<GetSnapshotInfoContext,SnapshotInfo> consumer,
 ActionListener<Void> listener)

Method Details

snapshotIds

public List<SnapshotId> snapshotIds()

abortOnFailure

public boolean abortOnFailure()

Returns:

true if fetching SnapshotInfo should be stopped after encountering any exception

isCancelled

public boolean isCancelled()

Returns:

true if fetching SnapshotInfo has been cancelled

done

public boolean done()

Returns:

true if fetching SnapshotInfo is either complete or should be stopped because of an error

onResponse

public void onResponse(SnapshotInfo snapshotInfo)

Description copied from interface: ActionListener

Handle action response. This response may constitute a failure or a success but it is up to the listener to make that decision.

Specified by:

onResponse in interface ActionListener<SnapshotInfo>

onFailure

public void onFailure(Exception e)

Description copied from interface: ActionListener

A failure caused by an exception at some phase of the task.

Specified by:

onFailure in interface ActionListener<SnapshotInfo>