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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<QueryAssistantRequest.Builder,QueryAssistantRequest>

@Generated("software.amazon.awssdk:codegen")
public final class QueryAssistantRequest
extends QConnectRequest
implements ToCopyableBuilder<QueryAssistantRequest.Builder,QueryAssistantRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface QueryAssistantRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`assistantId()`	The identifier of the Amazon Q in Connect assistant.
`static QueryAssistantRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasQueryCondition()`	For responses, this returns true if the service returned a value for the QueryCondition property.
`Integer`	`maxResults()`	The maximum number of results to return per page.
`String`	`nextToken()`	The token for the next set of results.
`KnowledgeBaseSearchType`	`overrideKnowledgeBaseSearchType()`	The search type to be used against the Knowledge Base for this request.
`String`	`overrideKnowledgeBaseSearchTypeAsString()`	The search type to be used against the Knowledge Base for this request.
`List<QueryCondition>`	`queryCondition()`	Information about how to query content.
`QueryInputData`	`queryInputData()`	Information about the query.
`String`	`queryText()`	The text to search for.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends QueryAssistantRequest.Builder>`	`serializableBuilderClass()`
`String`	`sessionId()`	The identifier of the Amazon Q in Connect session.
`QueryAssistantRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of results to return per page.
    
    Returns:
    
    The maximum number of results to return per page.
  - nextToken
```
public final String nextToken()
```
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
    
    Returns:
    
    The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
  - overrideKnowledgeBaseSearchType
```
public final KnowledgeBaseSearchType overrideKnowledgeBaseSearchType()
```
    The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
    
    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:
    
    The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
    
    See Also:
    
    KnowledgeBaseSearchType
  - overrideKnowledgeBaseSearchTypeAsString
```
public final String overrideKnowledgeBaseSearchTypeAsString()
```
    The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
    
    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:
    
    The search type to be used against the Knowledge Base for this request. The values can be SEMANTIC which uses vector embeddings or HYBRID which use vector embeddings and raw text.
    
    See Also:
    
    KnowledgeBaseSearchType
  - hasQueryCondition
```
public final boolean hasQueryCondition()
```
    For responses, this returns true if the service returned a value for the QueryCondition property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - queryCondition
```
public final List<QueryCondition> queryCondition()
```
    Information about how to query content.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasQueryCondition() method.
    
    Returns:
    
    Information about how to query content.
  - queryInputData
```
public final QueryInputData queryInputData()
```
    Information about the query.
    
    Returns:
    
    Information about the query.
  - queryText
```
public final String queryText()
```
    The text to search for.
    
    Returns:
    
    The text to search for.
  - sessionId
```
public final String sessionId()
```
    The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
    
    Returns:
    
    The identifier of the Amazon Q in Connect session. Can be either the ID or the ARN. URLs cannot contain the ARN.
  - toBuilder
```
public QueryAssistantRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<QueryAssistantRequest.Builder,QueryAssistantRequest>
    
    Specified by:
    
    toBuilder in class QConnectRequest
  - builder
```
public static QueryAssistantRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends QueryAssistantRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class QueryAssistantRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

assistantId

maxResults

nextToken

overrideKnowledgeBaseSearchType

overrideKnowledgeBaseSearchTypeAsString

hasQueryCondition

queryCondition

queryInputData

queryText

sessionId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField