com.amazonaws.services.bedrockagent.model

Class CreateKnowledgeBaseRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockagent.model.CreateKnowledgeBaseRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
CreateKnowledgeBaseRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateKnowledgeBaseRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateKnowledgeBaseRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
String	getDescription() A description of the knowledge base.
KnowledgeBaseConfiguration	getKnowledgeBaseConfiguration() Contains details about the embeddings model used for the knowledge base.
String	getName() A name for the knowledge base.
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
StorageConfiguration	getStorageConfiguration() Contains details about the configuration of the vector database used for the knowledge base.
Map<String,String>	getTags() Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
int	hashCode()
void	setClientToken(String clientToken) A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
void	setDescription(String description) A description of the knowledge base.
void	setKnowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration) Contains details about the embeddings model used for the knowledge base.
void	setName(String name) A name for the knowledge base.
void	setRoleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
void	setStorageConfiguration(StorageConfiguration storageConfiguration) Contains details about the configuration of the vector database used for the knowledge base.
void	setTags(Map<String,String> tags) Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.
String	toString() Returns a string representation of this object.
CreateKnowledgeBaseRequest	withClientToken(String clientToken) A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateKnowledgeBaseRequest	withDescription(String description) A description of the knowledge base.
CreateKnowledgeBaseRequest	withKnowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration) Contains details about the embeddings model used for the knowledge base.
CreateKnowledgeBaseRequest	withName(String name) A name for the knowledge base.
CreateKnowledgeBaseRequest	withRoleArn(String roleArn) The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
CreateKnowledgeBaseRequest	withStorageConfiguration(StorageConfiguration storageConfiguration) Contains details about the configuration of the vector database used for the knowledge base.
CreateKnowledgeBaseRequest	withTags(Map<String,String> tags) Specify the key-value pairs for the tags that you want to attach to your knowledge base in this object.

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

CreateKnowledgeBaseRequest

public CreateKnowledgeBaseRequest()

Method Detail

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateKnowledgeBaseRequest withClientToken(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.

Parameters:

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:

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

setDescription

public void setDescription(String description)

A description of the knowledge base.

Parameters:

description - A description of the knowledge base.

getDescription

public String getDescription()

A description of the knowledge base.

Returns:

A description of the knowledge base.

withDescription

public CreateKnowledgeBaseRequest withDescription(String description)

A description of the knowledge base.

Parameters:

description - A description of the knowledge base.

Returns:

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

setKnowledgeBaseConfiguration

public void setKnowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)

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

Parameters:

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

getKnowledgeBaseConfiguration

public KnowledgeBaseConfiguration getKnowledgeBaseConfiguration()

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

Returns:

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

withKnowledgeBaseConfiguration

public CreateKnowledgeBaseRequest withKnowledgeBaseConfiguration(KnowledgeBaseConfiguration knowledgeBaseConfiguration)

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

Parameters:

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

Returns:

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

setName

public void setName(String name)

A name for the knowledge base.

Parameters:

name - A name for the knowledge base.

getName

public String getName()

A name for the knowledge base.

Returns:

A name for the knowledge base.

withName

public CreateKnowledgeBaseRequest withName(String name)

A name for the knowledge base.

Parameters:

name - A name for the knowledge base.

Returns:

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

setRoleArn

public void setRoleArn(String roleArn)

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

Parameters:

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

getRoleArn

public String getRoleArn()

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.

withRoleArn

public CreateKnowledgeBaseRequest withRoleArn(String roleArn)

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

Parameters:

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

Returns:

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

setStorageConfiguration

public void setStorageConfiguration(StorageConfiguration storageConfiguration)

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

Parameters:

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

getStorageConfiguration

public StorageConfiguration getStorageConfiguration()

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.

withStorageConfiguration

public CreateKnowledgeBaseRequest withStorageConfiguration(StorageConfiguration storageConfiguration)

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

Parameters:

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

Returns:

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

getTags

public Map<String,String> getTags()

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

Returns:

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

setTags

public void setTags(Map<String,String> tags)

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

Parameters:

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

withTags

public CreateKnowledgeBaseRequest withTags(Map<String,String> tags)

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

Parameters:

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

Returns:

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

addTagsEntry

public CreateKnowledgeBaseRequest addTagsEntry(String key,
                                               String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateKnowledgeBaseRequest clearTagsEntries()

Removes all the entries added into Tags.

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