Class RenderingConfiguration

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

Information about how to render the content.

See Also:

  • Method Details

    • templateUri

      public final String templateUri()

      A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

      • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

      • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

      • Zendesk: id, title, updated_at, or draft

      The variable is replaced with the actual value for a piece of content when calling GetContent.

      Returns:
      A URI template containing exactly one variable in ${variableName} format. This can only be set for EXTERNAL knowledge bases. For Salesforce, ServiceNow, and Zendesk, the variable must be one of the following:

      • Salesforce: Id, ArticleNumber, VersionNumber, Title, PublishStatus, or IsDeleted

      • ServiceNow: number, short_description, sys_mod_count, workflow_state, or active

      • Zendesk: id, title, updated_at, or draft

      The variable is replaced with the actual value for a piece of content when calling GetContent.

    • toBuilder

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

    • builder

      public static RenderingConfiguration.Builder builder()

    • serializableBuilderClass

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