SnapshotShardFailure (Elasticsearch: Core 2.3.5.1 API)

java.lang.Object
- org.elasticsearch.snapshots.SnapshotShardFailure

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

ShardOperationFailedException, Streamable, ToXContent
```
public class SnapshotShardFailure
extends Object
implements ShardOperationFailedException
```
Stores information about failures that occurred during shard snapshotting process

ネストされたクラスのサマリー
- インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent
  ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

フィールドのサマリー
- インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent
  EMPTY_PARAMS

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

コンストラクタ
コンストラクタと説明
`SnapshotShardFailure(String nodeId, String index, int shardId, String reason)` Constructs new snapshot shard failure object

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static SnapshotShardFailure`	`fromXContent(XContentParser parser)` Deserializes snapshot failure information from JSON
`Throwable`	`getCause()` The cause of this failure.
`String`	`index()` Returns index where failure occurred
`String`	`nodeId()` Returns node id where failure occurred
`void`	`readFrom(StreamInput in)`
`static SnapshotShardFailure`	`readSnapshotShardFailure(StreamInput in)` Reads shard failure information from stream input
`String`	`reason()` Returns reason for the failure
`int`	`shardId()` Returns shard id where failure occurred
`RestStatus`	`status()` Returns REST status corresponding to this failure
`String`	`toString()`
`static void`	`toXContent(SnapshotShardFailure snapshotShardFailure, XContentBuilder builder, ToXContent.Params params)` Serializes snapshot failure information into JSON
`XContentBuilder`	`toXContent(XContentBuilder builder, ToXContent.Params params)`
`void`	`writeTo(StreamOutput out)`

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

- コンストラクタの詳細
  - SnapshotShardFailure
```
public SnapshotShardFailure(@Nullable
                            String nodeId,
                            String index,
                            int shardId,
                            String reason)
```
    Constructs new snapshot shard failure object
    
    パラメータ:
    
    nodeId - node where failure occurred
    
    index - index which the shard belongs to
    
    shardId - shard id
    
    reason - failure reason
- メソッドの詳細
  - index
```
public String index()
```
    Returns index where failure occurred
    
    定義:
    
    index インタフェース内 ShardOperationFailedException
    
    戻り値:
    
    index
  - shardId
```
public int shardId()
```
    Returns shard id where failure occurred
    
    定義:
    
    shardId インタフェース内 ShardOperationFailedException
    
    戻り値:
    
    shard id
  - reason
```
public String reason()
```
    Returns reason for the failure
    
    定義:
    
    reason インタフェース内 ShardOperationFailedException
    
    戻り値:
    
    reason for the failure
  - status
```
public RestStatus status()
```
    Returns REST status corresponding to this failure
    
    定義:
    
    status インタフェース内 ShardOperationFailedException
    
    戻り値:
    
    REST status
  - getCause
```
public Throwable getCause()
```
    インタフェースからコピーされた説明: ShardOperationFailedException
    
    The cause of this failure.
    
    定義:
    
    getCause インタフェース内 ShardOperationFailedException
    
    戻り値:
    
    The cause of this failure
  - nodeId
```
@Nullable
public String nodeId()
```
    Returns node id where failure occurred
    
    戻り値:
    
    node id
  - readSnapshotShardFailure
```
public static SnapshotShardFailure readSnapshotShardFailure(StreamInput in)
                                                     throws IOException
```
    Reads shard failure information from stream input
    
    パラメータ:
    
    in - stream input
    
    戻り値:
    
    shard failure information
    
    例外:
    
    IOException
  - readFrom
```
public void readFrom(StreamInput in)
              throws IOException
```
    定義:
    
    readFrom インタフェース内 Streamable
    
    例外:
    
    IOException
  - writeTo
```
public void writeTo(StreamOutput out)
             throws IOException
```
    定義:
    
    writeTo インタフェース内 Streamable
    
    例外:
    
    IOException
  - toString
```
public String toString()
```
    オーバーライド:
    
    toString クラス内 Object
  - toXContent
```
public static void toXContent(SnapshotShardFailure snapshotShardFailure,
                              XContentBuilder builder,
                              ToXContent.Params params)
                       throws IOException
```
    Serializes snapshot failure information into JSON
    
    パラメータ:
    
    snapshotShardFailure - snapshot failure information
    
    builder - XContent builder
    
    params - additional parameters
    
    例外:
    
    IOException
  - fromXContent
```
public static SnapshotShardFailure fromXContent(XContentParser parser)
                                         throws IOException
```
    Deserializes snapshot failure information from JSON
    
    パラメータ:
    
    parser - JSON parser
    
    戻り値:
    
    snapshot failure information
    
    例外:
    
    IOException
  - toXContent
```
public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws IOException
```
    定義:
    
    toXContent インタフェース内 ToXContent
    
    例外:
    
    IOException

クラス SnapshotShardFailure

ネストされたクラスのサマリー

インタフェースから継承されたネストされたクラス/インタフェース org.elasticsearch.common.xcontent.ToXContent

フィールドのサマリー

インタフェースから継承されたフィールド org.elasticsearch.common.xcontent.ToXContent

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

メソッドのサマリー

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

コンストラクタの詳細

SnapshotShardFailure

メソッドの詳細

index

shardId

reason

status

getCause

nodeId

readSnapshotShardFailure

readFrom

writeTo

toString

toXContent

fromXContent

toXContent