Package org.opensearch.snapshots

Class SnapshotException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.opensearch.OpenSearchException

org.opensearch.snapshots.SnapshotException

All Implemented Interfaces:

Serializable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

Direct Known Subclasses:

ConcurrentSnapshotExecutionException, InvalidSnapshotNameException, SnapshotCreationException, SnapshotInUseDeletionException, SnapshotMissingException, SnapshotRestoreException

public class SnapshotException
extends org.opensearch.OpenSearchException

Generic snapshot exception

See Also:

• Serialized Form

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.OpenSearchException

org.opensearch.OpenSearchException.OpenSearchExceptionHandle, org.opensearch.OpenSearchException.OpenSearchExceptionHandleRegistry

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.OpenSearchException

headers, metadata, REST_EXCEPTION_SKIP_STACK_TRACE, REST_EXCEPTION_SKIP_STACK_TRACE_DEFAULT, STACK_TRACE, UNKNOWN_VERSION_ADDED

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SnapshotException(String repositoryName, String snapshotName, String msg)
SnapshotException(String repositoryName, String snapshotName, String msg, Throwable cause)
SnapshotException(String repositoryName, SnapshotId snapshotId, String msg, Throwable cause)
SnapshotException(org.opensearch.core.common.io.stream.StreamInput in)
SnapshotException(Snapshot snapshot, String msg)
SnapshotException(Snapshot snapshot, String msg, Throwable cause)

Method Summary

Modifier and Type	Method	Description
String	getRepositoryName()
String	getSnapshotName()
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class org.opensearch.OpenSearchException

addHeader, addHeader, addMetadata, addMetadata, failureFromXContent, fromXContent, generateFailureXContent, generateThrowableXContent, getDetailedMessage, getExceptionName, getExceptionName, getExceptionSimpleClassName, getHeader, getHeaderKeys, getHeaders, getId, getIndex, getMetadata, getMetadata, getMetadataKeys, getResourceId, getResourceType, getRootCause, getShardId, guessRootCauses, guessRootCauses, headerToXContent, innerFromXContent, innerToXContent, isRegistered, metadataToXContent, readException, readStackTrace, setIndex, setIndex, setResources, setShard, status, toString, toXContent, unwrapCause, writeStackTraces

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Constructor Details

SnapshotException

public SnapshotException(Snapshot snapshot,
 String msg)

SnapshotException

public SnapshotException(Snapshot snapshot,
 String msg,
 Throwable cause)

SnapshotException

public SnapshotException(String repositoryName,
 SnapshotId snapshotId,
 String msg,
 Throwable cause)

SnapshotException

public SnapshotException(String repositoryName,
 String snapshotName,
 String msg)

SnapshotException

public SnapshotException(String repositoryName,
 String snapshotName,
 String msg,
 Throwable cause)

SnapshotException

public SnapshotException(org.opensearch.core.common.io.stream.StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Overrides:

writeTo in class org.opensearch.OpenSearchException

Throws:

IOException

getRepositoryName

@Nullable
public String getRepositoryName()

getSnapshotName

@Nullable
public String getSnapshotName()