Class AppliedGuardrailDetails
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockruntime.model.AppliedGuardrailDetails
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AppliedGuardrailDetails.Builder,AppliedGuardrailDetails>
@Generated("software.amazon.awssdk:codegen") public final class AppliedGuardrailDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AppliedGuardrailDetails.Builder,AppliedGuardrailDetails>
Details about the specific guardrail that was applied during this assessment, including its identifier, version, ARN, origin, and ownership information.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAppliedGuardrailDetails.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static AppliedGuardrailDetails.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)StringguardrailArn()The ARN of the guardrail that was applied.StringguardrailId()The unique ID of the guardrail that was applied.List<GuardrailOrigin>guardrailOrigin()The origin of how the guardrail was applied.List<String>guardrailOriginAsStrings()The origin of how the guardrail was applied.GuardrailOwnershipguardrailOwnership()The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.StringguardrailOwnershipAsString()The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.StringguardrailVersion()The version of the guardrail that was applied.booleanhasGuardrailOrigin()For responses, this returns true if the service returned a value for the GuardrailOrigin property.inthashCode()Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends AppliedGuardrailDetails.Builder>serializableBuilderClass()AppliedGuardrailDetails.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.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
guardrailId
public final String guardrailId()
The unique ID of the guardrail that was applied.
- Returns:
- The unique ID of the guardrail that was applied.
-
guardrailVersion
public final String guardrailVersion()
The version of the guardrail that was applied.
- Returns:
- The version of the guardrail that was applied.
-
guardrailArn
public final String guardrailArn()
The ARN of the guardrail that was applied.
- Returns:
- The ARN of the guardrail that was applied.
-
guardrailOrigin
public final List<GuardrailOrigin> guardrailOrigin()
The origin of how the guardrail was applied. This can be either requested at the API level or enforced at the account or organization level as a default 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
hasGuardrailOrigin()method.- Returns:
- The origin of how the guardrail was applied. This can be either requested at the API level or enforced at the account or organization level as a default guardrail.
-
hasGuardrailOrigin
public final boolean hasGuardrailOrigin()
For responses, this returns true if the service returned a value for the GuardrailOrigin property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
guardrailOriginAsStrings
public final List<String> guardrailOriginAsStrings()
The origin of how the guardrail was applied. This can be either requested at the API level or enforced at the account or organization level as a default 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
hasGuardrailOrigin()method.- Returns:
- The origin of how the guardrail was applied. This can be either requested at the API level or enforced at the account or organization level as a default guardrail.
-
guardrailOwnership
public final GuardrailOwnership guardrailOwnership()
The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.
If the service returns an enum value that is not available in the current SDK version,
guardrailOwnershipwill returnGuardrailOwnership.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromguardrailOwnershipAsString().- Returns:
- The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.
- See Also:
GuardrailOwnership
-
guardrailOwnershipAsString
public final String guardrailOwnershipAsString()
The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.
If the service returns an enum value that is not available in the current SDK version,
guardrailOwnershipwill returnGuardrailOwnership.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromguardrailOwnershipAsString().- Returns:
- The ownership type of the guardrail, indicating whether it is owned by the requesting account or is a cross-account guardrail shared from another AWS account.
- See Also:
GuardrailOwnership
-
toBuilder
public AppliedGuardrailDetails.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AppliedGuardrailDetails.Builder,AppliedGuardrailDetails>
-
builder
public static AppliedGuardrailDetails.Builder builder()
-
serializableBuilderClass
public static Class<? extends AppliedGuardrailDetails.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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-