Class StreamingConfigurations

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

Configurations for streaming.

See Also:

  • Method Details

    • applyGuardrailInterval

      public final Integer applyGuardrailInterval()

      The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.

      Example response in chunks: Interval set to 3 characters

      'Hel', 'lo, ','I am', ' an', ' Age', 'nt'

      Each chunk has at least 3 characters except for the last chunk

      Example response in chunks: Interval set to 20 or more characters

      Hello, I am an Agent

      Returns:
      The guardrail interval to apply as response is generated. By default, the guardrail interval is set to 50 characters. If a larger interval is specified, the response will be generated in larger chunks with fewer ApplyGuardrail calls. The following examples show the response generated for Hello, I am an agent input string.

      Example response in chunks: Interval set to 3 characters

      'Hel', 'lo, ','I am', ' an', ' Age', 'nt'

      Each chunk has at least 3 characters except for the last chunk

      Example response in chunks: Interval set to 20 or more characters

      Hello, I am an Agent

    • streamFinalResponse

      public final Boolean streamFinalResponse()

      Specifies whether to enable streaming for the final response. This is set to false by default.

      Returns:
      Specifies whether to enable streaming for the final response. This is set to false by default.

    • toBuilder

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

    • builder

      public static StreamingConfigurations.Builder builder()

    • serializableBuilderClass

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