org.elasticsearch.repositories.blobstore

Class BlobStoreSnapshot.Builder

java.lang.Object

org.elasticsearch.repositories.blobstore.BlobStoreSnapshot.Builder

Enclosing class:

BlobStoreSnapshot

public static class BlobStoreSnapshot.Builder
extends Object

BlobStoreSnapshot builder

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BlobStoreSnapshot	build() Builds new BlobStoreSnapshot
BlobStoreSnapshot.Builder	endTime(long endTime) Sets snapshot end time
BlobStoreSnapshot.Builder	failed(String reason) Marks snapshot as failed and saves failure reason
BlobStoreSnapshot.Builder	failures(int totalShard, com.google.common.collect.ImmutableList<SnapshotShardFailure> shardFailures) Sets the total number of shards and the list of individual shard failures
static BlobStoreSnapshot	fromXContent(XContentParser parser) Parses the snapshot
BlobStoreSnapshot.Builder	indices(Collection<String> indices) Sets list of indices in the snapshot
BlobStoreSnapshot.Builder	indices(String[] indices) Sets list of indices in the snapshot
BlobStoreSnapshot.Builder	name(String name) Sets snapshot name
BlobStoreSnapshot.Builder	partial() Marks snapshot as partially successful
BlobStoreSnapshot.Builder	reason(String reason) Sets snapshot failure reason
BlobStoreSnapshot.Builder	shardFailures(com.google.common.collect.ImmutableList<SnapshotShardFailure> shardFailures) Sets the list of individual shard failures
BlobStoreSnapshot.Builder	snapshot(BlobStoreSnapshot snapshot) Copies data from another snapshot into the builder
BlobStoreSnapshot.Builder	startTime(long startTime) Sets snapshot start time
BlobStoreSnapshot.Builder	state(SnapshotState state) Sets snapshot state
BlobStoreSnapshot.Builder	success() Marks snapshot as successful
BlobStoreSnapshot.Builder	successfulShards(int successfulShards) Sets total number fo shards that were successfully snapshotted
BlobStoreSnapshot.Builder	totalShard(int totalShard) Sets total number of shards across all snapshot indices
static void	toXContent(BlobStoreSnapshot snapshot, XContentBuilder builder, ToXContent.Params params) Serializes the snapshot
BlobStoreSnapshot.Builder	version(Version version) Sets version of Elasticsearch that created this snapshot

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

snapshot

public BlobStoreSnapshot.Builder snapshot(BlobStoreSnapshot snapshot)

Copies data from another snapshot into the builder

Parameters:

snapshot - another snapshot

Returns:

this builder

name

public BlobStoreSnapshot.Builder name(String name)

Sets snapshot name

Parameters:

name - snapshot name

Returns:

this builder

indices

public BlobStoreSnapshot.Builder indices(Collection<String> indices)

Sets list of indices in the snapshot

Parameters:

indices - list of indices

Returns:

this builder

indices

public BlobStoreSnapshot.Builder indices(String[] indices)

Sets list of indices in the snapshot

Parameters:

indices - list of indices

Returns:

this builder

state

public BlobStoreSnapshot.Builder state(SnapshotState state)

Sets snapshot state

Parameters:

state - snapshot state

Returns:

this builder

reason

public BlobStoreSnapshot.Builder reason(String reason)

Sets snapshot failure reason

Parameters:

reason - snapshot failure reason

Returns:

this builder

success

public BlobStoreSnapshot.Builder success()

Marks snapshot as successful

Returns:

this builder

partial

public BlobStoreSnapshot.Builder partial()

Marks snapshot as partially successful

Returns:

this builder

failed

public BlobStoreSnapshot.Builder failed(String reason)

Marks snapshot as failed and saves failure reason

Parameters:

reason - failure reason

Returns:

this builder

version

public BlobStoreSnapshot.Builder version(Version version)

Sets version of Elasticsearch that created this snapshot

Parameters:

version - version

Returns:

this builder

startTime

public BlobStoreSnapshot.Builder startTime(long startTime)

Sets snapshot start time

Parameters:

startTime - snapshot start time

Returns:

this builder

endTime

public BlobStoreSnapshot.Builder endTime(long endTime)

Sets snapshot end time

Parameters:

endTime - snapshot end time

Returns:

this builder

totalShard

public BlobStoreSnapshot.Builder totalShard(int totalShard)

Sets total number of shards across all snapshot indices

Parameters:

totalShard - number of shards

Returns:

this builder

successfulShards

public BlobStoreSnapshot.Builder successfulShards(int successfulShards)

Sets total number fo shards that were successfully snapshotted

Parameters:

successfulShards - number of successful shards

Returns:

this builder

shardFailures

public BlobStoreSnapshot.Builder shardFailures(com.google.common.collect.ImmutableList<SnapshotShardFailure> shardFailures)

Sets the list of individual shard failures

Parameters:

shardFailures - list of shard failures

Returns:

this builder

failures

public BlobStoreSnapshot.Builder failures(int totalShard,
                                          com.google.common.collect.ImmutableList<SnapshotShardFailure> shardFailures)

Sets the total number of shards and the list of individual shard failures

Parameters:

totalShard - number of shards

shardFailures - list of shard failures

Returns:

this builder

build

public BlobStoreSnapshot build()

Builds new BlobStoreSnapshot

Returns:

toXContent

public static void toXContent(BlobStoreSnapshot snapshot,
                              XContentBuilder builder,
                              ToXContent.Params params)
                       throws IOException

Serializes the snapshot

Parameters:

snapshot - snapshot to be serialized

builder - XContent builder

params - serialization parameters

Throws:

IOException

fromXContent

public static BlobStoreSnapshot fromXContent(XContentParser parser)
                                      throws IOException

Parses the snapshot

Parameters:

parser - XContent parser

Returns:

snapshot

Throws:

IOException