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

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

Method Summary

Modifier and Type	Method	Description
void	accept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)	Calls the appropriate visit method depending on the subtype of GuardrailEvent.
final GuadrailAction	action()	The guardrail action.
final String	actionAsString()	The guardrail action.
static GuardrailEvent.Builder	builder()
final GuardrailEvent	copy(Consumer<? super GuardrailEvent.Builder> modifier)	A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailEvent.Builder>	serializableBuilderClass()
GuardrailEvent.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

sdkEventType

Method Details

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from interface: ToCopyableBuilder

A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.

Specified by:

copy in interface ToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>

Parameters:

modifier - A function that mutates this immutable object using the provided builder.

Returns:

A new copy of this object with the requested modifications.

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.

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.