Class GuardrailStreamConfiguration

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

Configuration information for a guardrail that you use with the ConverseStream action.

See Also:

  • Method Details

    • guardrailIdentifier

      public final String guardrailIdentifier()

      The identifier for the guardrail.

      Returns:
      The identifier for the guardrail.

    • guardrailVersion

      public final String guardrailVersion()

      The version of the guardrail.

      Returns:
      The version of the guardrail.

    • trace

      public final GuardrailTrace trace()

      The trace behavior for the guardrail.

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

      Returns:
      The trace behavior for the guardrail.
      See Also:

    • traceAsString

      public final String traceAsString()

      The trace behavior for the guardrail.

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

      Returns:
      The trace behavior for the guardrail.
      See Also:

    • streamProcessingMode

      public final GuardrailStreamProcessingMode streamProcessingMode()

      The processing mode.

      The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

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

      Returns:
      The processing mode.

      The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

      See Also:

    • streamProcessingModeAsString

      public final String streamProcessingModeAsString()

      The processing mode.

      The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

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

      Returns:
      The processing mode.

      The processing mode. For more information, see Configure streaming response behavior in the Amazon Bedrock User Guide.

      See Also:

    • toBuilder

      public GuardrailStreamConfiguration.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<GuardrailStreamConfiguration.Builder,GuardrailStreamConfiguration>
      Returns:
      a builder for type T

    • builder

      public static GuardrailStreamConfiguration.Builder builder()

    • serializableBuilderClass

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