Class RetrievalInstructionFailureReason

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.RetrievalInstructionFailureReason
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RetrievalInstructionFailureReason.Builder,RetrievalInstructionFailureReason>
@Generated("software.amazon.awssdk:codegen") public final class RetrievalInstructionFailureReason extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RetrievalInstructionFailureReason.Builder,RetrievalInstructionFailureReason>

One reason the most recent create or update did not succeed. code drives programmatic branching (fix the text, fix the configuration, or retry); message carries the specific cause.

See Also:

  • Method Details

    • fieldName

      public final RetrievalInstructionFieldName fieldName()

      The instruction field this entry is about. Present on review rejections of a specific field; absent when the failure applies to the whole review, because a client-side execution failure or a service fault has no single field.

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

      Returns:
      The instruction field this entry is about. Present on review rejections of a specific field; absent when the failure applies to the whole review, because a client-side execution failure or a service fault has no single field.
      See Also:

    • fieldNameAsString

      public final String fieldNameAsString()

      The instruction field this entry is about. Present on review rejections of a specific field; absent when the failure applies to the whole review, because a client-side execution failure or a service fault has no single field.

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

      Returns:
      The instruction field this entry is about. Present on review rejections of a specific field; absent when the failure applies to the whole review, because a client-side execution failure or a service fault has no single field.
      See Also:

    • code

      public final RetrievalInstructionFailureReasonCode code()

      Stable, machine-readable classification by fault attribution. Valid values:

      • CONTENT_REJECTED – The review rejected the named field's content; revise the text and resubmit.

      • CLIENT_ERROR – The review could not run for a customer-side reason, for example the customer managed AWS KMS key could not be used; fix the configuration and resubmit.

      • INTERNAL_ERROR – The review could not complete due to a service fault; retry the create or update.

      New values may be added over time; your client should tolerate values it does not recognize and treat them as a failure.

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

      Returns:
      Stable, machine-readable classification by fault attribution. Valid values:

      • CONTENT_REJECTED – The review rejected the named field's content; revise the text and resubmit.

      • CLIENT_ERROR – The review could not run for a customer-side reason, for example the customer managed AWS KMS key could not be used; fix the configuration and resubmit.

      • INTERNAL_ERROR – The review could not complete due to a service fault; retry the create or update.

      New values may be added over time; your client should tolerate values it does not recognize and treat them as a failure.

      See Also:

    • codeAsString

      public final String codeAsString()

      Stable, machine-readable classification by fault attribution. Valid values:

      • CONTENT_REJECTED – The review rejected the named field's content; revise the text and resubmit.

      • CLIENT_ERROR – The review could not run for a customer-side reason, for example the customer managed AWS KMS key could not be used; fix the configuration and resubmit.

      • INTERNAL_ERROR – The review could not complete due to a service fault; retry the create or update.

      New values may be added over time; your client should tolerate values it does not recognize and treat them as a failure.

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

      Returns:
      Stable, machine-readable classification by fault attribution. Valid values:

      • CONTENT_REJECTED – The review rejected the named field's content; revise the text and resubmit.

      • CLIENT_ERROR – The review could not run for a customer-side reason, for example the customer managed AWS KMS key could not be used; fix the configuration and resubmit.

      • INTERNAL_ERROR – The review could not complete due to a service fault; retry the create or update.

      New values may be added over time; your client should tolerate values it does not recognize and treat them as a failure.

      See Also:

    • message

      public final String message()

      Human-readable explanation of the specific cause. Never contains the customer's own text.

      Returns:
      Human-readable explanation of the specific cause. Never contains the customer's own text.

    • toBuilder

      public RetrievalInstructionFailureReason.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RetrievalInstructionFailureReason.Builder,RetrievalInstructionFailureReason>
      Returns:
      a builder for type T

    • builder

      public static RetrievalInstructionFailureReason.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RetrievalInstructionFailureReason.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.