Package ai.attackframework.tools.burp.sinks

Record Class OpenSearchSink.IndexResult

java.lang.Object

java.lang.Record

ai.attackframework.tools.burp.sinks.OpenSearchSink.IndexResult

Record Components:

shortName - logical name used to select the mapping file

fullName - fully-qualified index name

status - CREATED, EXISTS, or FAILED

error - concise reason when status == FAILED; otherwise null

Enclosing class:

OpenSearchSink

public static record OpenSearchSink.IndexResult(String shortName, String fullName, OpenSearchSink.IndexResult.Status status, String error)
extends Record

Result of an index creation attempt.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OpenSearchSink.IndexResult.Status

Constructor Summary

Constructors

Constructor	Description
IndexResult(String shortName, String fullName, OpenSearchSink.IndexResult.Status status, String error)	Creates an instance of a IndexResult record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	error()	Returns the value of the error record component.
String	fullName()	Returns the value of the fullName record component.
final int	hashCode()	Returns a hash code value for this object.
String	shortName()	Returns the value of the shortName record component.
OpenSearchSink.IndexResult.Status	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

IndexResult

public IndexResult(String shortName,
 String fullName,
 OpenSearchSink.IndexResult.Status status,
 String error)

Creates an instance of a IndexResult record class.

Parameters:

shortName - the value for the shortName record component

fullName - the value for the fullName record component

status - the value for the status record component

error - the value for the error record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

shortName

public String shortName()

Returns the value of the shortName record component.

Returns:

the value of the shortName record component

fullName

public String fullName()

Returns the value of the fullName record component.

Returns:

the value of the fullName record component

status

public OpenSearchSink.IndexResult.Status status()

Returns the value of the status record component.

Returns:

the value of the status record component

error

public String error()

Returns the value of the error record component.

Returns:

the value of the error record component