Class AgenticRetrieveWarning
java.lang.Object
software.amazon.awssdk.services.bedrockagentruntime.model.AgenticRetrieveWarning
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AgenticRetrieveWarning.Builder,AgenticRetrieveWarning>
@Generated("software.amazon.awssdk:codegen")
public final class AgenticRetrieveWarning
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AgenticRetrieveWarning.Builder,AgenticRetrieveWarning>
A warning generated during agentic retrieval.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interfacestatic enum -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.static AgenticRetrieveWarningCreate an instance of this class withguardrail()initialized to the given value.static AgenticRetrieveWarningfromGuardrail(AgenticRetrieveGuardrailWarning guardrail) Create an instance of this class withguardrail()initialized to the given value.static AgenticRetrieveWarningCreate an instance of this class withmessage()initialized to the given value.static AgenticRetrieveWarningfromMessage(AgenticRetrieveWarningMessage message) Create an instance of this class withmessage()initialized to the given value.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) A warning from a guardrail evaluation.final inthashCode()message()A general warning message.static Class<? extends AgenticRetrieveWarning.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.type()Retrieve an enum value representing which member of this object is populated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
guardrail
A warning from a guardrail evaluation.
- Returns:
- A warning from a guardrail evaluation.
-
message
A general warning message.
- Returns:
- A general warning message.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<AgenticRetrieveWarning.Builder,AgenticRetrieveWarning> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
fromGuardrail
Create an instance of this class withguardrail()initialized to the given value.A warning from a guardrail evaluation.
- Parameters:
guardrail- A warning from a guardrail evaluation.
-
fromGuardrail
public static AgenticRetrieveWarning fromGuardrail(Consumer<AgenticRetrieveGuardrailWarning.Builder> guardrail) Create an instance of this class withguardrail()initialized to the given value.A warning from a guardrail evaluation.
- Parameters:
guardrail- A warning from a guardrail evaluation.
-
fromMessage
Create an instance of this class withmessage()initialized to the given value.A general warning message.
- Parameters:
message- A general warning message.
-
fromMessage
public static AgenticRetrieveWarning fromMessage(Consumer<AgenticRetrieveWarningMessage.Builder> message) Create an instance of this class withmessage()initialized to the given value.A general warning message.
- Parameters:
message- A general warning message.
-
type
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beAgenticRetrieveWarning.Type.UNKNOWN_TO_SDK_VERSIONif the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beAgenticRetrieveWarning.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set. -
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-