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 interfaceGuardrailEvent.Builderprotected static classGuardrailEvent.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 protectedGuardrailEvent(GuardrailEvent.BuilderImpl builder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)Calls the appropriate visit method depending on the subtype ofGuardrailEvent.GuadrailActionaction()The guardrail action.StringactionAsString()The guardrail action.static GuardrailEvent.Builderbuilder()GuardrailEventcopy(Consumer<? super GuardrailEvent.Builder> modifier)booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GuardrailEvent.Builder>serializableBuilderClass()GuardrailEvent.BuildertoBuilder()StringtoString()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,
actionwill returnGuadrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromactionAsString().- 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,
actionwill returnGuadrailAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromactionAsString().- Returns:
- The guardrail action.
- See Also:
GuadrailAction
-
toBuilder
public GuardrailEvent.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>
-
builder
public static GuardrailEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends GuardrailEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
copy
public final GuardrailEvent copy(Consumer<? super GuardrailEvent.Builder> modifier)
- Specified by:
copyin interfaceToCopyableBuilder<GuardrailEvent.Builder,GuardrailEvent>
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
accept
public void accept(RetrieveAndGenerateStreamResponseHandler.Visitor visitor)
Calls the appropriate visit method depending on the subtype ofGuardrailEvent.- Specified by:
acceptin interfaceRetrieveAndGenerateStreamResponseOutput- Parameters:
visitor- Visitor to invoke.
-
-