Package org.opensearch.ml.common.model

Class Guardrails

java.lang.Object

org.opensearch.ml.common.model.Guardrails

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class Guardrails
extends Object
implements org.opensearch.core.xcontent.ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Guardrails.GuardrailsBuilder

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INPUT_GUARDRAIL_FIELD
static final String	OUTPUT_GUARDRAIL_FIELD
static final String	TYPE_FIELD

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Guardrails(String type, Guardrail inputGuardrail, Guardrail outputGuardrail)
Guardrails(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static Guardrails.GuardrailsBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Guardrail	getInputGuardrail()
Guardrail	getOutputGuardrail()
String	getType()
int	hashCode()
static Guardrails	parse(org.opensearch.core.xcontent.XContentParser parser)
Guardrails.GuardrailsBuilder	toBuilder()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

TYPE_FIELD

public static final String TYPE_FIELD

See Also:

• Constant Field Values

INPUT_GUARDRAIL_FIELD

public static final String INPUT_GUARDRAIL_FIELD

See Also:

• Constant Field Values

OUTPUT_GUARDRAIL_FIELD

public static final String OUTPUT_GUARDRAIL_FIELD

See Also:

• Constant Field Values

Constructor Details

Guardrails

public Guardrails(String type,
 Guardrail inputGuardrail,
 Guardrail outputGuardrail)

Guardrails

public Guardrails(org.opensearch.core.common.io.stream.StreamInput input)
           throws IOException

Throws:

IOException

Method Details

writeTo

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

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

parse

public static Guardrails parse(org.opensearch.core.xcontent.XContentParser parser)
                        throws IOException

Throws:

IOException

builder

public static Guardrails.GuardrailsBuilder builder()

toBuilder

public Guardrails.GuardrailsBuilder toBuilder()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getType

public String getType()

getInputGuardrail

public Guardrail getInputGuardrail()

getOutputGuardrail

public Guardrail getOutputGuardrail()