org.elasticsearch.snapshots

Class SnapshotsService.SnapshotRequest

java.lang.Object

org.elasticsearch.snapshots.SnapshotsService.SnapshotRequest

Enclosing class:

SnapshotsService

public static class SnapshotsService.SnapshotRequest
extends Object

Snapshot creation request

Constructor Summary

Constructors

Constructor and Description
SnapshotsService.SnapshotRequest(String cause, String name, String repository) Constructs new snapshot creation request

Method Summary

Methods

Modifier and Type	Method and Description
String	cause() Returns cause for snapshot operation
boolean	includeGlobalState() Returns true if global state should be stored as part of the snapshot
SnapshotsService.SnapshotRequest	includeGlobalState(boolean includeGlobalState) Set to true if global state should be stored as part of the snapshot
String[]	indices() Returns the list of indices to be snapshotted
SnapshotsService.SnapshotRequest	indices(String[] indices) Sets the list of indices to be snapshotted
IndicesOptions	indicesOptions() Returns indices options
SnapshotsService.SnapshotRequest	indicesOptions(IndicesOptions indicesOptions) Sets the indices options
TimeValue	masterNodeTimeout() Returns master node timeout
SnapshotsService.SnapshotRequest	masterNodeTimeout(TimeValue masterNodeTimeout) Sets master node timeout
String	name() Returns snapshot name
SnapshotsService.SnapshotRequest	partial(boolean partial) Set to true if partial snapshot should be allowed
String	repository() Returns snapshot repository
Settings	settings() Returns repository-specific settings for the snapshot operation
SnapshotsService.SnapshotRequest	settings(Settings settings) Sets repository-specific snapshot settings

Methods inherited from class java.lang.Object

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

Constructor Detail

SnapshotsService.SnapshotRequest

public SnapshotsService.SnapshotRequest(String cause,
                                String name,
                                String repository)

Constructs new snapshot creation request

Parameters:

cause - cause for snapshot operation

name - name of the snapshot

repository - name of the repository

Method Detail

indices

public SnapshotsService.SnapshotRequest indices(String[] indices)

Sets the list of indices to be snapshotted

Parameters:

indices - list of indices

Returns:

this request

settings

public SnapshotsService.SnapshotRequest settings(Settings settings)

Sets repository-specific snapshot settings

Parameters:

settings - snapshot settings

Returns:

this request

includeGlobalState

public SnapshotsService.SnapshotRequest includeGlobalState(boolean includeGlobalState)

Set to true if global state should be stored as part of the snapshot

Parameters:

includeGlobalState - true if global state should be stored as part of the snapshot

Returns:

this request

masterNodeTimeout

public SnapshotsService.SnapshotRequest masterNodeTimeout(TimeValue masterNodeTimeout)

Sets master node timeout

Parameters:

masterNodeTimeout - master node timeout

Returns:

this request

indicesOptions

public SnapshotsService.SnapshotRequest indicesOptions(IndicesOptions indicesOptions)

Sets the indices options

Parameters:

indicesOptions - indices options

Returns:

this request

partial

public SnapshotsService.SnapshotRequest partial(boolean partial)

Set to true if partial snapshot should be allowed

Parameters:

partial - true if partial snapshots should be allowed

Returns:

this request

cause

public String cause()

Returns cause for snapshot operation

Returns:

cause for snapshot operation

name

public String name()

Returns snapshot name

Returns:

snapshot name

repository

public String repository()

Returns snapshot repository

Returns:

snapshot repository

indices

public String[] indices()

Returns the list of indices to be snapshotted

Returns:

the list of indices

indicesOptions

public IndicesOptions indicesOptions()

Returns indices options

Returns:

indices options

settings

public Settings settings()

Returns repository-specific settings for the snapshot operation

Returns:

repository-specific settings

includeGlobalState

public boolean includeGlobalState()

Returns true if global state should be stored as part of the snapshot

Returns:

true if global state should be stored as part of the snapshot

masterNodeTimeout

public TimeValue masterNodeTimeout()

Returns master node timeout

Returns:

master node timeout