com.amazonaws.services.qbusiness.model

Class ListMessagesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qbusiness.model.ListMessagesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListMessagesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListMessagesRequest()

Method Summary

Modifier and Type	Method and Description
ListMessagesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationId() The identifier for the Amazon Q Business application.
String	getConversationId() The identifier of the Amazon Q Business web experience conversation.
Integer	getMaxResults() The maximum number of messages to return.
String	getNextToken() If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.
String	getUserId() The identifier of the user involved in the Amazon Q Business web experience conversation.
int	hashCode()
void	setApplicationId(String applicationId) The identifier for the Amazon Q Business application.
void	setConversationId(String conversationId) The identifier of the Amazon Q Business web experience conversation.
void	setMaxResults(Integer maxResults) The maximum number of messages to return.
void	setNextToken(String nextToken) If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.
void	setUserId(String userId) The identifier of the user involved in the Amazon Q Business web experience conversation.
String	toString() Returns a string representation of this object.
ListMessagesRequest	withApplicationId(String applicationId) The identifier for the Amazon Q Business application.
ListMessagesRequest	withConversationId(String conversationId) The identifier of the Amazon Q Business web experience conversation.
ListMessagesRequest	withMaxResults(Integer maxResults) The maximum number of messages to return.
ListMessagesRequest	withNextToken(String nextToken) If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.
ListMessagesRequest	withUserId(String userId) The identifier of the user involved in the Amazon Q Business web experience conversation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListMessagesRequest

public ListMessagesRequest()

Method Detail

setConversationId

public void setConversationId(String conversationId)

The identifier of the Amazon Q Business web experience conversation.

Parameters:

conversationId - The identifier of the Amazon Q Business web experience conversation.

getConversationId

public String getConversationId()

The identifier of the Amazon Q Business web experience conversation.

Returns:

The identifier of the Amazon Q Business web experience conversation.

withConversationId

public ListMessagesRequest withConversationId(String conversationId)

The identifier of the Amazon Q Business web experience conversation.

Parameters:

conversationId - The identifier of the Amazon Q Business web experience conversation.

Returns:

Returns a reference to this object so that method calls can be chained together.

setApplicationId

public void setApplicationId(String applicationId)

The identifier for the Amazon Q Business application.

Parameters:

applicationId - The identifier for the Amazon Q Business application.

getApplicationId

public String getApplicationId()

The identifier for the Amazon Q Business application.

Returns:

The identifier for the Amazon Q Business application.

withApplicationId

public ListMessagesRequest withApplicationId(String applicationId)

The identifier for the Amazon Q Business application.

Parameters:

applicationId - The identifier for the Amazon Q Business application.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserId

public void setUserId(String userId)

The identifier of the user involved in the Amazon Q Business web experience conversation.

Parameters:

userId - The identifier of the user involved in the Amazon Q Business web experience conversation.

getUserId

public String getUserId()

The identifier of the user involved in the Amazon Q Business web experience conversation.

Returns:

The identifier of the user involved in the Amazon Q Business web experience conversation.

withUserId

public ListMessagesRequest withUserId(String userId)

The identifier of the user involved in the Amazon Q Business web experience conversation.

Parameters:

userId - The identifier of the user involved in the Amazon Q Business web experience conversation.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

Parameters:

nextToken - If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

getNextToken

public String getNextToken()

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

Returns:

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

withNextToken

public ListMessagesRequest withNextToken(String nextToken)

If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

Parameters:

nextToken - If the number of retrievers returned exceeds maxResults, Amazon Q Business returns a next token as a pagination token to retrieve the next set of messages.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of messages to return.

Parameters:

maxResults - The maximum number of messages to return.

getMaxResults

public Integer getMaxResults()

The maximum number of messages to return.

Returns:

The maximum number of messages to return.

withMaxResults

public ListMessagesRequest withMaxResults(Integer maxResults)

The maximum number of messages to return.

Parameters:

maxResults - The maximum number of messages to return.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListMessagesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()