Class CreatorModeConfiguration

java.lang.Object
software.amazon.awssdk.services.qbusiness.model.CreatorModeConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CreatorModeConfiguration.Builder,CreatorModeConfiguration>

@Generated("software.amazon.awssdk:codegen") public final class CreatorModeConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CreatorModeConfiguration.Builder,CreatorModeConfiguration>

Configuration information required to invoke chat in CREATOR_MODE.

For more information, see Admin controls and guardrails and Conversation settings.

See Also:
  • Method Details

    • creatorModeControl

      public final CreatorModeControl creatorModeControl()

      Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.

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

      Returns:
      Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.
      See Also:
    • creatorModeControlAsString

      public final String creatorModeControlAsString()

      Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.

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

      Returns:
      Status information about whether CREATOR_MODE has been enabled or disabled. The default status is DISABLED.
      See Also:
    • 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<CreatorModeConfiguration.Builder,CreatorModeConfiguration>
      Returns:
      a builder for type T
    • builder

      public static CreatorModeConfiguration.Builder builder()
    • serializableBuilderClass

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