Package org.elasticsearch.snapshots
Class SnapshotsService.SnapshotRequest
- java.lang.Object
-
- org.elasticsearch.snapshots.SnapshotsService.SnapshotRequest
-
- Enclosing class:
- SnapshotsService
public static class SnapshotsService.SnapshotRequest extends java.lang.Object
Snapshot creation request
-
-
Constructor Summary
Constructors Constructor Description SnapshotRequest(java.lang.String repositoryName, java.lang.String snapshotName, java.lang.String cause)
Constructs new snapshot creation request
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
cause()
Returns cause for snapshot operationboolean
includeGlobalState()
Returns true if global state should be stored as part of the snapshotSnapshotsService.SnapshotRequest
includeGlobalState(boolean includeGlobalState)
Set to true if global state should be stored as part of the snapshotjava.lang.String[]
indices()
Returns the list of indices to be snapshottedSnapshotsService.SnapshotRequest
indices(java.lang.String[] indices)
Sets the list of indices to be snapshottedIndicesOptions
indicesOptions()
Returns indices optionsSnapshotsService.SnapshotRequest
indicesOptions(IndicesOptions indicesOptions)
Sets the indices optionsTimeValue
masterNodeTimeout()
Returns master node timeoutSnapshotsService.SnapshotRequest
masterNodeTimeout(TimeValue masterNodeTimeout)
Sets master node timeoutboolean
partial()
Returns true if partial snapshot should be allowedSnapshotsService.SnapshotRequest
partial(boolean partial)
Set to true if partial snapshot should be allowedjava.lang.String
repositoryName()
Returns the repository nameSettings
settings()
Returns repository-specific settings for the snapshot operationSnapshotsService.SnapshotRequest
settings(Settings settings)
Sets repository-specific snapshot settingsjava.lang.String
snapshotName()
Returns the snapshot name
-
-
-
Method Detail
-
indices
public SnapshotsService.SnapshotRequest indices(java.lang.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 java.lang.String cause()
Returns cause for snapshot operation- Returns:
- cause for snapshot operation
-
repositoryName
public java.lang.String repositoryName()
Returns the repository name
-
snapshotName
public java.lang.String snapshotName()
Returns the snapshot name
-
indices
public java.lang.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
-
partial
public boolean partial()
Returns true if partial snapshot should be allowed- Returns:
- true if partial snapshot should be allowed
-
masterNodeTimeout
public TimeValue masterNodeTimeout()
Returns master node timeout- Returns:
- master node timeout
-
-