Package software.amazon.awssdk.services.bedrockruntime.model

Class ApplyGuardrailResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeResponse

software.amazon.awssdk.services.bedrockruntime.model.ApplyGuardrailResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ApplyGuardrailResponse.Builder,ApplyGuardrailResponse>

@Generated("software.amazon.awssdk:codegen")
public final class ApplyGuardrailResponse
extends BedrockRuntimeResponse
implements ToCopyableBuilder<ApplyGuardrailResponse.Builder,ApplyGuardrailResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApplyGuardrailResponse.Builder

Method Summary

Modifier and Type	Method	Description
GuardrailAction	action()	The action taken in the response from the guardrail.
String	actionAsString()	The action taken in the response from the guardrail.
List<GuardrailAssessment>	assessments()	The assessment details in the response from the guardrail.
static ApplyGuardrailResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAssessments()	For responses, this returns true if the service returned a value for the Assessments property.
int	hashCode()
boolean	hasOutputs()	For responses, this returns true if the service returned a value for the Outputs property.
List<GuardrailOutputContent>	outputs()	The output details in the response from the guardrail.
List<SdkField<?>>	sdkFields()
static Class<? extends ApplyGuardrailResponse.Builder>	serializableBuilderClass()
ApplyGuardrailResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
GuardrailUsage	usage()	The usage details in the response from the guardrail.

Methods inherited from class software.amazon.awssdk.services.bedrockruntime.model.BedrockRuntimeResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

usage

public final GuardrailUsage usage()

The usage details in the response from the guardrail.

Returns:

The usage details in the response from the guardrail.

action

public final GuardrailAction action()

The action taken in the response from 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 action taken in the response from the guardrail.

See Also:

GuardrailAction

actionAsString

public final String actionAsString()

The action taken in the response from 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 action taken in the response from the guardrail.

See Also:

GuardrailAction

hasOutputs

public final boolean hasOutputs()

For responses, this returns true if the service returned a value for the Outputs 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.

outputs

public final List<GuardrailOutputContent> outputs()

The output details in the response from the guardrail.

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 hasOutputs() method.

Returns:

The output details in the response from the guardrail.

hasAssessments

public final boolean hasAssessments()

For responses, this returns true if the service returned a value for the Assessments 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.

assessments

public final List<GuardrailAssessment> assessments()

The assessment details in the response from the guardrail.

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 hasAssessments() method.

Returns:

The assessment details in the response from the guardrail.

toBuilder

public ApplyGuardrailResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApplyGuardrailResponse.Builder,ApplyGuardrailResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ApplyGuardrailResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo