Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.inference.results

Record Class ModelStoreResponse

java.lang.Object

java.lang.Record

org.elasticsearch.xpack.core.inference.results.ModelStoreResponse

All Implemented Interfaces:

Writeable

public record ModelStoreResponse(String inferenceId, RestStatus status, Exception failureCause)
extends Record
implements Writeable

Response for storing a model in the model registry using the bulk API.

Nested Class Summary

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

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
ModelStoreResponse(String inferenceId, RestStatus status, Exception failureCause)	Creates an instance of a ModelStoreResponse record class.
ModelStoreResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
boolean	failed()
Exception	failureCause()	Returns the value of the failureCause record component.
int	hashCode()	Returns a hash code value for this object.
String	inferenceId()	Returns the value of the inferenceId record component.
RestStatus	status()	Returns the value of the status record component.
final String	toString()	Returns a string representation of this record class.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Details

ModelStoreResponse

public ModelStoreResponse(StreamInput in)
                   throws IOException

Throws:

IOException

ModelStoreResponse

public ModelStoreResponse(String inferenceId,
 RestStatus status,
 @Nullable
 Exception failureCause)

Creates an instance of a ModelStoreResponse record class.

Parameters:

inferenceId - the value for the inferenceId record component

status - the value for the status record component

failureCause - the value for the failureCause record component

Method Details

failed

public boolean failed()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public 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.

hashCode

public 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

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

inferenceId

public String inferenceId()

Returns the value of the inferenceId record component.

Returns:

the value of the inferenceId record component

status

public RestStatus status()

Returns the value of the status record component.

Returns:

the value of the status record component

failureCause

@Nullable
public Exception failureCause()

Returns the value of the failureCause record component.

Returns:

the value of the failureCause record component