Class PredictQaResultsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.quicksight.model.QuickSightRequest
software.amazon.awssdk.services.quicksight.model.PredictQaResultsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PredictQaResultsRequest.Builder,PredictQaResultsRequest>
@Generated("software.amazon.awssdk:codegen") public final class PredictQaResultsRequest extends QuickSightRequest implements ToCopyableBuilder<PredictQaResultsRequest.Builder,PredictQaResultsRequest>

  • Method Details

    • awsAccountId

      public final String awsAccountId()

      The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.

      Returns:
      The ID of the Amazon Web Services account that the user wants to execute Predict QA results in.

    • queryText

      public final String queryText()

      The query text to be used to predict QA results.

      Returns:
      The query text to be used to predict QA results.

    • includeQuickSightQIndex

      public final IncludeQuickSightQIndex includeQuickSightQIndex()

      Indicates whether Q indicies are included or excluded.

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

      Returns:
      Indicates whether Q indicies are included or excluded.
      See Also:

    • includeQuickSightQIndexAsString

      public final String includeQuickSightQIndexAsString()

      Indicates whether Q indicies are included or excluded.

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

      Returns:
      Indicates whether Q indicies are included or excluded.
      See Also:

    • includeGeneratedAnswer

      public final IncludeGeneratedAnswer includeGeneratedAnswer()

      Indicates whether generated answers are included or excluded.

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

      Returns:
      Indicates whether generated answers are included or excluded.
      See Also:

    • includeGeneratedAnswerAsString

      public final String includeGeneratedAnswerAsString()

      Indicates whether generated answers are included or excluded.

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

      Returns:
      Indicates whether generated answers are included or excluded.
      See Also:

    • maxTopicsToConsider

      public final Integer maxTopicsToConsider()

      The number of maximum topics to be considered to predict QA results.

      Returns:
      The number of maximum topics to be considered to predict QA results.

    • toBuilder

      public PredictQaResultsRequest.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<PredictQaResultsRequest.Builder,PredictQaResultsRequest>
      Specified by:
      toBuilder in class QuickSightRequest
      Returns:
      a builder for type T

    • builder

      public static PredictQaResultsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PredictQaResultsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.