RecoveryStatus (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.common.util.concurrent.AbstractRefCounted
- - org.elasticsearch.indices.recovery.RecoveryStatus

すべての実装されたインタフェース:

RefCounted
```
public class RecoveryStatus
extends AbstractRefCounted
```

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

RecoveryStatus(IndexShard indexShard, DiscoveryNode sourceNode, RecoveryTarget.RecoveryListener listener)

コンストラクタ
コンストラクタと説明
`RecoveryStatus(IndexShard indexShard, DiscoveryNode sourceNode, RecoveryTarget.RecoveryListener listener)`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`void`	`cancel(String reason)` cancel the recovery. calling this method will clean temporary files and release the store unless this object is in use (in which case it will be cleaned once all ongoing users call `AbstractRefCounted.decRef()` if `CancellableThreads()` was used, the threads will be interrupted.
`CancellableThreads`	`CancellableThreads()`
`protected void`	`cleanOpenFiles()`
`protected void`	`closeInternal()`
`void`	`fail(RecoveryFailedException e, boolean sendShardFailure)` fail the recovery and call listener
`org.apache.lucene.store.IndexOutput`	`getOpenIndexOutput(String key)`
`String`	`getTempNameForFile(String origFile)` Get a temporary name for the provided file name.
`IndexShard`	`indexShard()`
`long`	`lastAccessTime()` return the last time this RecoveryStatus was used (based on System.nanoTime()
`Store.LegacyChecksums`	`legacyChecksums()`
`void`	`markAsDone()` mark the current recovery as done
`org.apache.lucene.store.IndexOutput`	`openAndPutIndexOutput(String fileName, StoreFileMetaData metaData, Store store)` Creates an `IndexOutput` for the given file name.
`long`	`recoveryId()`
`org.apache.lucene.store.IndexOutput`	`removeOpenIndexOutputs(String name)` remove and `IndexOutput` for a given file.
`void`	`renameAllTempFiles()` renames all temporary files to their true name, potentially overriding existing files
`void`	`resetRecovery()`
`void`	`setLastAccessTime()` sets the lasAccessTime flag to now
`ShardId`	`shardId()`
`DiscoveryNode`	`sourceNode()`
`RecoveryState.Stage`	`stage()`
`RecoveryState`	`state()`
`Store`	`store()`
`String`	`toString()`

クラスから継承されたメソッド org.elasticsearch.common.util.concurrent.AbstractRefCounted
alreadyClosed, decRef, getName, incRef, refCount, tryIncRef

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

RecoveryStatus

public RecoveryStatus(IndexShard indexShard,
                      DiscoveryNode sourceNode,
                      RecoveryTarget.RecoveryListener listener)

メソッドの詳細

recoveryId
```
public long recoveryId()
```

shardId
```
public ShardId shardId()
```

indexShard
```
public IndexShard indexShard()
```

sourceNode
```
public DiscoveryNode sourceNode()
```

state
```
public RecoveryState state()
```

CancellableThreads

public CancellableThreads CancellableThreads()

lastAccessTime
```
public long lastAccessTime()
```
return the last time this RecoveryStatus was used (based on System.nanoTime()

setLastAccessTime
```
public void setLastAccessTime()
```
sets the lasAccessTime flag to now

store
```
public Store store()
```

stage
```
public RecoveryState.Stage stage()
```

legacyChecksums

public Store.LegacyChecksums legacyChecksums()

renameAllTempFiles
```
public void renameAllTempFiles()
                        throws IOException
```
renames all temporary files to their true name, potentially overriding existing files

例外:

IOException

cancel
```
public void cancel(String reason)
```
cancel the recovery. calling this method will clean temporary files and release the store unless this object is in use (in which case it will be cleaned once all ongoing users call AbstractRefCounted.decRef()
if CancellableThreads() was used, the threads will be interrupted.

fail
```
public void fail(RecoveryFailedException e,
                 boolean sendShardFailure)
```
fail the recovery and call listener

パラメータ:

e - exception that encapsulating the failure

sendShardFailure - indicates whether to notify the master of the shard failure

markAsDone
```
public void markAsDone()
```
mark the current recovery as done

getTempNameForFile
```
public String getTempNameForFile(String origFile)
```
Get a temporary name for the provided file name.

getOpenIndexOutput

public org.apache.lucene.store.IndexOutput getOpenIndexOutput(String key)

removeOpenIndexOutputs
```
public org.apache.lucene.store.IndexOutput removeOpenIndexOutputs(String name)
```
remove and IndexOutput for a given file. It is the caller's responsibility to close it

openAndPutIndexOutput

public org.apache.lucene.store.IndexOutput openAndPutIndexOutput(String fileName,
                                                                 StoreFileMetaData metaData,
                                                                 Store store)
                                                          throws IOException

Creates an IndexOutput for the given file name. Note that the IndexOutput actually point at a temporary file.

Note: You can use getOpenIndexOutput(String) with the same filename to retrieve the same IndexOutput at a later stage

例外:: IOException

resetRecovery

public void resetRecovery()
                   throws IOException

例外:: IOException

closeInternal
```
protected void closeInternal()
```
定義:

closeInternal クラス内 AbstractRefCounted

cleanOpenFiles
```
protected void cleanOpenFiles()
```

toString
```
public String toString()
```
オーバーライド:

toString クラス内 Object

クラス RecoveryStatus

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド org.elasticsearch.common.util.concurrent.AbstractRefCounted

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

RecoveryStatus

メソッドの詳細

recoveryId

shardId

indexShard

sourceNode

state

CancellableThreads

lastAccessTime

setLastAccessTime

store

stage

legacyChecksums

renameAllTempFiles

cancel

fail

markAsDone

getTempNameForFile

getOpenIndexOutput

removeOpenIndexOutputs

openAndPutIndexOutput

resetRecovery

closeInternal

cleanOpenFiles

toString