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

Class CreateKnowledgeBaseRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateKnowledgeBaseRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateKnowledgeBaseRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
String	description()	A description of the knowledge base.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
KnowledgeBaseConfiguration	knowledgeBaseConfiguration()	Contains details about the embeddings model used for the knowledge base.
String	name()	A name for the knowledge base.
String	roleArn()	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateKnowledgeBaseRequest.Builder>	serializableBuilderClass()
StorageConfiguration	storageConfiguration()	Contains details about the configuration of the vector database used for the knowledge base.
Map<String,String>	tags()	Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
CreateKnowledgeBaseRequest.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

clientToken

public final String clientToken()

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

Returns:

A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

description

public final String description()

A description of the knowledge base.

Returns:

A description of the knowledge base.

knowledgeBaseConfiguration

public final KnowledgeBaseConfiguration knowledgeBaseConfiguration()

Contains details about the embeddings model used for the knowledge base.

Returns:

Contains details about the embeddings model used for the knowledge base.

name

public final String name()

A name for the knowledge base.

Returns:

A name for the knowledge base.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

Returns:

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

storageConfiguration

public final StorageConfiguration storageConfiguration()

Contains details about the configuration of the vector database used for the knowledge base.

Returns:

Contains details about the configuration of the vector database used for the knowledge base.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

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

Returns:

Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

toBuilder

public CreateKnowledgeBaseRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateKnowledgeBaseRequest.Builder,CreateKnowledgeBaseRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static CreateKnowledgeBaseRequest.Builder builder()

serializableBuilderClass

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