public static class SnapshotsService.SnapshotRequest
extends java.lang.Object
Constructor | Description |
---|---|
SnapshotRequest(java.lang.String repositoryName,
java.lang.String snapshotName,
java.lang.String cause) |
Constructs new snapshot creation request
|
Modifier and Type | Method | Description |
---|---|---|
java.lang.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
|
java.lang.String[] |
indices() |
Returns the list of indices to be snapshotted
|
SnapshotsService.SnapshotRequest |
indices(java.lang.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
|
boolean |
partial() |
Returns true if partial snapshot should be allowed
|
SnapshotsService.SnapshotRequest |
partial(boolean partial) |
Set to true if partial snapshot should be allowed
|
java.lang.String |
repositoryName() |
Returns the repository name
|
Settings |
settings() |
Returns repository-specific settings for the snapshot operation
|
SnapshotsService.SnapshotRequest |
settings(Settings settings) |
Sets repository-specific snapshot settings
|
java.lang.String |
snapshotName() |
Returns the snapshot name
|
public SnapshotRequest(java.lang.String repositoryName, java.lang.String snapshotName, java.lang.String cause)
repositoryName
- repository namesnapshotName
- snapshot namecause
- cause for snapshot operationpublic SnapshotsService.SnapshotRequest indices(java.lang.String[] indices)
indices
- list of indicespublic SnapshotsService.SnapshotRequest settings(Settings settings)
settings
- snapshot settingspublic SnapshotsService.SnapshotRequest includeGlobalState(boolean includeGlobalState)
includeGlobalState
- true if global state should be stored as part of the snapshotpublic SnapshotsService.SnapshotRequest masterNodeTimeout(TimeValue masterNodeTimeout)
masterNodeTimeout
- master node timeoutpublic SnapshotsService.SnapshotRequest indicesOptions(IndicesOptions indicesOptions)
indicesOptions
- indices optionspublic SnapshotsService.SnapshotRequest partial(boolean partial)
partial
- true if partial snapshots should be allowedpublic java.lang.String cause()
public java.lang.String repositoryName()
public java.lang.String snapshotName()
public java.lang.String[] indices()
public IndicesOptions indicesOptions()
public Settings settings()
public boolean includeGlobalState()
public boolean partial()
public TimeValue masterNodeTimeout()