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

Class GuardrailTrace

java.lang.Object

software.amazon.awssdk.services.bedrockagentruntime.model.GuardrailTrace

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<GuardrailTrace.Builder,GuardrailTrace>

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

The trace details used in the Guardrail.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GuardrailTrace.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailAction	action()	The trace action details used with the Guardrail.
String	actionAsString()	The trace action details used with the Guardrail.
static GuardrailTrace.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInputAssessments()	For responses, this returns true if the service returned a value for the InputAssessments property.
boolean	hasOutputAssessments()	For responses, this returns true if the service returned a value for the OutputAssessments property.
List<GuardrailAssessment>	inputAssessments()	The details of the input assessments used in the Guardrail Trace.
List<GuardrailAssessment>	outputAssessments()	The details of the output assessments used in the Guardrail Trace.
List<SdkField<?>>	sdkFields()
static Class<? extends GuardrailTrace.Builder>	serializableBuilderClass()
GuardrailTrace.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	traceId()	The details of the trace Id used in the Guardrail Trace.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

action

public final GuardrailAction action()

The trace action details used with the Guardrail.

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

Returns:

The trace action details used with the Guardrail.

See Also:

GuardrailAction

actionAsString

public final String actionAsString()

The trace action details used with the Guardrail.

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

Returns:

The trace action details used with the Guardrail.

See Also:

GuardrailAction

hasInputAssessments

public final boolean hasInputAssessments()

For responses, this returns true if the service returned a value for the InputAssessments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

inputAssessments

public final List<GuardrailAssessment> inputAssessments()

The details of the input assessments used in the Guardrail Trace.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInputAssessments() method.

Returns:

The details of the input assessments used in the Guardrail Trace.

hasOutputAssessments

public final boolean hasOutputAssessments()

For responses, this returns true if the service returned a value for the OutputAssessments property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

outputAssessments

public final List<GuardrailAssessment> outputAssessments()

The details of the output assessments used in the Guardrail Trace.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutputAssessments() method.

Returns:

The details of the output assessments used in the Guardrail Trace.

traceId

public final String traceId()

The details of the trace Id used in the Guardrail Trace.

Returns:

The details of the trace Id used in the Guardrail Trace.

toBuilder

public GuardrailTrace.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GuardrailTrace.Builder,GuardrailTrace>

builder

public static GuardrailTrace.Builder builder()

serializableBuilderClass

public static Class<? extends GuardrailTrace.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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo