Package software.amazon.awssdk.services.qbusiness.model

Class ListDocumentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qbusiness.model.QBusinessRequest

software.amazon.awssdk.services.qbusiness.model.ListDocumentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListDocumentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the application id the documents are attached to.
static ListDocumentsRequest.Builder	builder()
List<String>	dataSourceIds()	The identifier of the data sources the documents are attached to.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDataSourceIds()	For responses, this returns true if the service returned a value for the DataSourceIds property.
int	hashCode()
String	indexId()	The identifier of the index the documents are attached to.
Integer	maxResults()	The maximum number of documents to return.
String	nextToken()	If the maxResults response was incomplete because there is more data to retrieve, Amazon Q returns a pagination token in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ListDocumentsRequest.Builder>	serializableBuilderClass()
ListDocumentsRequest.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

applicationId

public final String applicationId()

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

Returns:

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

hasDataSourceIds

public final boolean hasDataSourceIds()

For responses, this returns true if the service returned a value for the DataSourceIds 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.

dataSourceIds

public final List<String> dataSourceIds()

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

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 hasDataSourceIds() method.

Returns:

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

indexId

public final String indexId()

The identifier of the index the documents are attached to.

Returns:

The identifier of the index the documents are attached to.

maxResults

public final Integer maxResults()

The maximum number of documents to return.

Returns:

The maximum number of documents to return.

nextToken

public final 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.

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.

toBuilder

public ListDocumentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static ListDocumentsRequest.Builder builder()

serializableBuilderClass

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