Package software.amazon.awssdk.services.bedrockagent.model

Class ListKnowledgeBaseDocumentsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest

software.amazon.awssdk.services.bedrockagent.model.ListKnowledgeBaseDocumentsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListKnowledgeBaseDocumentsRequest.Builder,ListKnowledgeBaseDocumentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListKnowledgeBaseDocumentsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListKnowledgeBaseDocumentsRequest.Builder	builder()
String	dataSourceId()	The unique identifier of the data source that contains the documents.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	knowledgeBaseId()	The unique identifier of the knowledge base that is connected to the data source.
Integer	maxResults()	The maximum number of results to return in the response.
String	nextToken()	If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListKnowledgeBaseDocumentsRequest.Builder>	serializableBuilderClass()
ListKnowledgeBaseDocumentsRequest.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

knowledgeBaseId

public final String knowledgeBaseId()

The unique identifier of the knowledge base that is connected to the data source.

Returns:

The unique identifier of the knowledge base that is connected to the data source.

dataSourceId

public final String dataSourceId()

The unique identifier of the data source that contains the documents.

Returns:

The unique identifier of the data source that contains the documents.

maxResults

public final Integer maxResults()

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

Returns:

The maximum number of results to return in the response. If the total number of results is greater than this value, use the token returned in the response in the nextToken field when making another request to return the next batch of results.

nextToken

public final String nextToken()

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

Returns:

If the total number of results is greater than the maxResults value provided in the request, enter the token returned in the nextToken field in the response in this field to return the next batch of results.

toBuilder

public ListKnowledgeBaseDocumentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListKnowledgeBaseDocumentsRequest.Builder,ListKnowledgeBaseDocumentsRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static ListKnowledgeBaseDocumentsRequest.Builder builder()

serializableBuilderClass

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