Package software.amazon.awssdk.services.bedrockagentruntime.model

Class GuardrailEvent

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.GuardrailEvent

All Implemented Interfaces:

Serializable, SdkPojo, RetrieveAndGenerateStreamResponseOutput, ToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>

Direct Known Subclasses:

DefaultGuardrail

@Generated("software.amazon.awssdk:codegen")
public class GuardrailEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>, RetrieveAndGenerateStreamResponseOutput

A guardrail event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailEvent.Builder
protected static class	GuardrailEvent.BuilderImpl

Nested classes/interfaces inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveAndGenerateStreamResponseOutput

RetrieveAndGenerateStreamResponseOutput.EventType

Field Summary

Fields inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveAndGenerateStreamResponseOutput

UNKNOWN

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GuardrailEvent(GuardrailEvent.BuilderImpl builder)

Method Summary

Modifier and Type	Method	Description
void	accept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of GuardrailEvent.
GuadrailAction	action()	The guardrail action.
String	actionAsString()	The guardrail action.
static GuardrailEvent.Builder	builder()
GuardrailEvent	copy(Consumer<? super GuardrailEvent.Builder> modifier)
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailEvent.Builder>	serializableBuilderClass()
GuardrailEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.services.bedrockagentruntime.model.RetrieveAndGenerateStreamResponseOutput

sdkEventType

Constructor Detail

GuardrailEvent

protected GuardrailEvent(GuardrailEvent.BuilderImpl builder)

Method Detail

action

public final GuadrailAction action()

The guardrail action.

If the service returns an enum value that is not available in the current SDK version, action will return GuadrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The guardrail action.

See Also:

GuadrailAction

actionAsString

public final String actionAsString()

The guardrail action.

If the service returns an enum value that is not available in the current SDK version, action will return GuadrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

The guardrail action.

See Also:

GuadrailAction

toBuilder

public GuardrailEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>

builder

public static GuardrailEvent.Builder builder()

serializableBuilderClass

public static Class<? extends GuardrailEvent.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

copy

public final GuardrailEvent copy(Consumer<? super GuardrailEvent.Builder> modifier)

Specified by:

copy in interface ToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

accept

public void accept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)

Calls the appropriate visit method depending on the subtype of GuardrailEvent.

Specified by:

accept in interface RetrieveAndGenerateStreamResponseOutput

Parameters:

visitor - Visitor to invoke.