com.amazonaws.services.qbusiness.model

Class ListDocumentsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.qbusiness.model.ListDocumentsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListDocumentsRequest
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
ListDocumentsRequest()

Method Summary

Modifier and Type	Method and Description
ListDocumentsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationId() The identifier of the application id the documents are attached to.
List<String>	getDataSourceIds() The identifier of the data sources the documents are attached to.
String	getIndexId() The identifier of the index the documents are attached to.
Integer	getMaxResults() The maximum number of documents to return.
String	getNextToken() If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response.
int	hashCode()
void	setApplicationId(String applicationId) The identifier of the application id the documents are attached to.
void	setDataSourceIds(Collection<String> dataSourceIds) The identifier of the data sources the documents are attached to.
void	setIndexId(String indexId) The identifier of the index the documents are attached to.
void	setMaxResults(Integer maxResults) The maximum number of documents to return.
void	setNextToken(String nextToken) If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response.
String	toString() Returns a string representation of this object.
ListDocumentsRequest	withApplicationId(String applicationId) The identifier of the application id the documents are attached to.
ListDocumentsRequest	withDataSourceIds(Collection<String> dataSourceIds) The identifier of the data sources the documents are attached to.
ListDocumentsRequest	withDataSourceIds(String... dataSourceIds) The identifier of the data sources the documents are attached to.
ListDocumentsRequest	withIndexId(String indexId) The identifier of the index the documents are attached to.
ListDocumentsRequest	withMaxResults(Integer maxResults) The maximum number of documents to return.
ListDocumentsRequest	withNextToken(String nextToken) If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response.

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

ListDocumentsRequest

public ListDocumentsRequest()

Method Detail

setApplicationId

public void setApplicationId(String applicationId)

The identifier of the application id the documents are attached to.

Parameters:

applicationId - The identifier of the application id the documents are attached to.

getApplicationId

public String getApplicationId()

The identifier of the application id the documents are attached to.

Returns:

The identifier of the application id the documents are attached to.

withApplicationId

public ListDocumentsRequest withApplicationId(String applicationId)

The identifier of the application id the documents are attached to.

Parameters:

applicationId - The identifier of the application id the documents are attached to.

Returns:

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

getDataSourceIds

public List<String> getDataSourceIds()

The identifier of the data sources the documents are attached to.

Returns:

The identifier of the data sources the documents are attached to.

setDataSourceIds

public void setDataSourceIds(Collection<String> dataSourceIds)

The identifier of the data sources the documents are attached to.

Parameters:

dataSourceIds - The identifier of the data sources the documents are attached to.

withDataSourceIds

public ListDocumentsRequest withDataSourceIds(String... dataSourceIds)

The identifier of the data sources the documents are attached to.

NOTE: This method appends the values to the existing list (if any). Use setDataSourceIds(java.util.Collection) or withDataSourceIds(java.util.Collection) if you want to override the existing values.

Parameters:

dataSourceIds - The identifier of the data sources the documents are attached to.

Returns:

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

withDataSourceIds

public ListDocumentsRequest withDataSourceIds(Collection<String> dataSourceIds)

The identifier of the data sources the documents are attached to.

Parameters:

dataSourceIds - The identifier of the data sources the documents are attached to.

Returns:

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

setIndexId

public void setIndexId(String indexId)

The identifier of the index the documents are attached to.

Parameters:

indexId - The identifier of the index the documents are attached to.

getIndexId

public String getIndexId()

The identifier of the index the documents are attached to.

Returns:

The identifier of the index the documents are attached to.

withIndexId

public ListDocumentsRequest withIndexId(String indexId)

The identifier of the index the documents are attached to.

Parameters:

indexId - The identifier of the index the documents are attached to.

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 documents to return.

Parameters:

maxResults - The maximum number of documents to return.

getMaxResults

public Integer getMaxResults()

The maximum number of documents to return.

Returns:

The maximum number of documents to return.

withMaxResults

public ListDocumentsRequest withMaxResults(Integer maxResults)

The maximum number of documents to return.

Parameters:

maxResults - The maximum number of documents to return.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

Parameters:

nextToken - If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

getNextToken

public String getNextToken()

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

Returns:

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

withNextToken

public ListDocumentsRequest withNextToken(String nextToken)

If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

Parameters:

nextToken - If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response. You can use this pagination token to retrieve the next set of documents.

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 ListDocumentsRequest 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()