Class GetRecommendationsRequest

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

  • Method Details

    • assistantId

      public final String assistantId()

      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

      Returns:
      The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • sessionId

      public final String sessionId()

      The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

      Returns:
      The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return per page.

      Returns:
      The maximum number of results to return per page.

    • waitTimeSeconds

      public final Integer waitTimeSeconds()

      The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

      Returns:
      The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds. If no messages are available and the wait time expires, the call returns successfully with an empty list.

    • nextChunkToken

      public final String nextChunkToken()

      The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.

      Returns:
      The token for the next set of chunks. Use the value returned in the previous response in the next request to retrieve the next set of chunks.

    • recommendationType

      public final RecommendationType recommendationType()

      The type of recommendation being requested.

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

      Returns:
      The type of recommendation being requested.
      See Also:

    • recommendationTypeAsString

      public final String recommendationTypeAsString()

      The type of recommendation being requested.

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

      Returns:
      The type of recommendation being requested.
      See Also:

    • toBuilder

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

    • builder

      public static GetRecommendationsRequest.Builder builder()

    • serializableBuilderClass

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