Class RetrievalConfiguration

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

Configuration for content retrieval operations.

See Also:

  • Method Details

    • knowledgeSource

      public final KnowledgeSource knowledgeSource()

      The knowledge source configuration for content retrieval.

      Returns:
      The knowledge source configuration for content retrieval.

    • filter

      public final RetrievalFilterConfiguration filter()

      The filter configuration for content retrieval.

      Returns:
      The filter configuration for content retrieval.

    • numberOfResults

      public final Integer numberOfResults()

      The number of results to retrieve.

      Returns:
      The number of results to retrieve.

    • overrideKnowledgeBaseSearchType

      public final KnowledgeBaseSearchType overrideKnowledgeBaseSearchType()

      Override setting for the knowledge base search type during retrieval.

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

      Returns:
      Override setting for the knowledge base search type during retrieval.
      See Also:

    • overrideKnowledgeBaseSearchTypeAsString

      public final String overrideKnowledgeBaseSearchTypeAsString()

      Override setting for the knowledge base search type during retrieval.

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

      Returns:
      Override setting for the knowledge base search type during retrieval.
      See Also:

    • toBuilder

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

    • builder

      public static RetrievalConfiguration.Builder builder()

    • serializableBuilderClass

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