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

Class ApplyGuardrailResponse

    • 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.

      • 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

      • actionReason

        public final String actionReason()

        The reason for the action taken when harmful content is detected.

        Returns:
        The reason for the action taken when harmful content is detected.

      • 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.

      • guardrailCoverage

        public final GuardrailCoverage guardrailCoverage()

        The guardrail coverage details in the apply guardrail response.

        Returns:
        The guardrail coverage details in the apply guardrail response.

      • 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