com.splunk.mint

Class DataSaverResponse

java.lang.Object

com.splunk.mint.DataSaverResponse

public class DataSaverResponse
extends java.lang.Object

The DataSaverResponse class is a callback from the MintCallback interface, which returns a DataSaverResponse object for a data save attempt. This object contains information about the data to be saved, the file path, the exception (if any, or `null`), and a Boolean indicating whether the data was saved successfully.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DataSaverResponse(java.lang.String data, java.lang.String filepath) Protected constructor for the DataSaverResponse class.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getData() Returns the data that was saved.
java.lang.Exception	getException() Returns an exception, if any.
java.lang.String	getFilepath() Returns the file path where the data was written.
java.lang.Boolean	getSavedSuccessfully() Indicates whether the data was saved successfully.
protected void	setException(java.lang.Exception exception) Sets the exception, if any.
protected void	setSavedSuccessfully(java.lang.Boolean savedSuccessfully) Indicates whether the data was saved successfully.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSaverResponse

protected DataSaverResponse(java.lang.String data,
                            java.lang.String filepath)

Protected constructor for the DataSaverResponse class. Users will never use this constructor.

Parameters:

data - The saved data.

filepath - The path of the file where data was saved.

Method Detail

getException

public java.lang.Exception getException()

Returns an exception, if any.

Returns:

The exception or `null`.

setException

protected void setException(java.lang.Exception exception)

Sets the exception, if any.

Parameters:

exception - The exception.

getSavedSuccessfully

public java.lang.Boolean getSavedSuccessfully()

Indicates whether the data was saved successfully.

Returns:

`true` if successful, `false` if not.

setSavedSuccessfully

protected void setSavedSuccessfully(java.lang.Boolean savedSuccessfully)

Indicates whether the data was saved successfully.

Parameters:

savedSuccessfully - `true` if successful, `false` if not.

getData

public java.lang.String getData()

Returns the data that was saved.

Returns:

The data.

getFilepath

public java.lang.String getFilepath()

Returns the file path where the data was written.

Returns:

The file path.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object