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

  All Methods

  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 that you provide to ensure the idempotency of the request.
  String	getDescription () The description.
  String	getKnowledgeBaseType () The type of knowledge base.
  String	getName () The name of the knowledge base.
  RenderingConfiguration	getRenderingConfiguration () Information about how to render the content.
  ServerSideEncryptionConfiguration	getServerSideEncryptionConfiguration () The configuration information for the customer managed key used for encryption.
  SourceConfiguration	getSourceConfiguration () The source of the knowledge base content.
  Map<String,String>	getTags () The tags used to organize, track, or control access for this resource.
  int	hashCode ()
  void	setClientToken (String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  void	setDescription (String description) The description.
  void	setKnowledgeBaseType (String knowledgeBaseType) The type of knowledge base.
  void	setName (String name) The name of the knowledge base.
  void	setRenderingConfiguration (RenderingConfiguration renderingConfiguration) Information about how to render the content.
  void	setServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The configuration information for the customer managed key used for encryption.
  void	setSourceConfiguration (SourceConfiguration sourceConfiguration) The source of the knowledge base content.
  void	setTags (Map<String,String> tags) The tags used to organize, track, or control access for this resource.
  String	toString () Returns a string representation of this object.
  CreateKnowledgeBaseRequest	withClientToken (String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  CreateKnowledgeBaseRequest	withDescription (String description) The description.
  CreateKnowledgeBaseRequest	withKnowledgeBaseType (KnowledgeBaseType knowledgeBaseType) The type of knowledge base.
  CreateKnowledgeBaseRequest	withKnowledgeBaseType (String knowledgeBaseType) The type of knowledge base.
  CreateKnowledgeBaseRequest	withName (String name) The name of the knowledge base.
  CreateKnowledgeBaseRequest	withRenderingConfiguration (RenderingConfiguration renderingConfiguration) Information about how to render the content.
  CreateKnowledgeBaseRequest	withServerSideEncryptionConfiguration (ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The configuration information for the customer managed key used for encryption.
  CreateKnowledgeBaseRequest	withSourceConfiguration (SourceConfiguration sourceConfiguration) The source of the knowledge base content.
  CreateKnowledgeBaseRequest	withTags (Map<String,String> tags) The tags used to organize, track, or control access for this resource.

  • 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 that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    Parameters:

    clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

  • getClientToken

    public String getClientToken()

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    Returns:

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

  • withClientToken

    public CreateKnowledgeBaseRequest withClientToken(String clientToken)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    Parameters:

    clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

    Returns:

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

  • setDescription

    public void setDescription(String description)

    The description.

    Parameters:

    description - The description.

  • getDescription

    public String getDescription()

    The description.

    Returns:

    The description.

  • withDescription

    public CreateKnowledgeBaseRequest withDescription(String description)

    The description.

    Parameters:

    description - The description.

    Returns:

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

  • setKnowledgeBaseType

    public void setKnowledgeBaseType(String knowledgeBaseType)

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    Parameters:

    knowledgeBaseType - The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    See Also:

    KnowledgeBaseType

  • getKnowledgeBaseType

    public String getKnowledgeBaseType()

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    Returns:

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    See Also:

    KnowledgeBaseType

  • withKnowledgeBaseType

    public CreateKnowledgeBaseRequest withKnowledgeBaseType(String knowledgeBaseType)

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    Parameters:

    knowledgeBaseType - The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    Returns:

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

    See Also:

    KnowledgeBaseType

  • withKnowledgeBaseType

    public CreateKnowledgeBaseRequest withKnowledgeBaseType(KnowledgeBaseType knowledgeBaseType)

    The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    Parameters:

    knowledgeBaseType - The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

    Returns:

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

    See Also:

    KnowledgeBaseType

  • setName

    public void setName(String name)

    The name of the knowledge base.

    Parameters:

    name - The name of the knowledge base.

  • getName

    public String getName()

    The name of the knowledge base.

    Returns:

    The name of the knowledge base.

  • withName

    public CreateKnowledgeBaseRequest withName(String name)

    The name of the knowledge base.

    Parameters:

    name - The name of the knowledge base.

    Returns:

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

  • setRenderingConfiguration

    public void setRenderingConfiguration(RenderingConfiguration renderingConfiguration)

    Information about how to render the content.

    Parameters:

    renderingConfiguration - Information about how to render the content.

  • getRenderingConfiguration

    public RenderingConfiguration getRenderingConfiguration()

    Information about how to render the content.

    Returns:

    Information about how to render the content.

  • withRenderingConfiguration

    public CreateKnowledgeBaseRequest withRenderingConfiguration(RenderingConfiguration renderingConfiguration)

    Information about how to render the content.

    Parameters:

    renderingConfiguration - Information about how to render the content.

    Returns:

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

  • setServerSideEncryptionConfiguration

    public void setServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

    The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

    Parameters:

    serverSideEncryptionConfiguration - The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

  • getServerSideEncryptionConfiguration

    public ServerSideEncryptionConfiguration getServerSideEncryptionConfiguration()

    The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

    Returns:

    The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

  • withServerSideEncryptionConfiguration

    public CreateKnowledgeBaseRequest withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

    The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

    Parameters:

    serverSideEncryptionConfiguration - The configuration information for the customer managed key used for encryption.

    This KMS key must have a policy that allows kms:CreateGrant, kms:DescribeKey, kms:Decrypt, and kms:GenerateDataKey* permissions to the IAM identity using the key to invoke Amazon Q in Connect.

    For more information about setting up a customer managed key for Amazon Q in Connect, see Enable Amazon Q in Connect for your instance.

    Returns:

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

  • setSourceConfiguration

    public void setSourceConfiguration(SourceConfiguration sourceConfiguration)

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

    Parameters:

    sourceConfiguration - The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

  • getSourceConfiguration

    public SourceConfiguration getSourceConfiguration()

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

    Returns:

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

  • withSourceConfiguration

    public CreateKnowledgeBaseRequest withSourceConfiguration(SourceConfiguration sourceConfiguration)

    The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

    Parameters:

    sourceConfiguration - The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

    Returns:

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

  • getTags

    public Map<String,String> getTags()

    The tags used to organize, track, or control access for this resource.

    Returns:

    The tags used to organize, track, or control access for this resource.

  • setTags

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

    The tags used to organize, track, or control access for this resource.

    Parameters:

    tags - The tags used to organize, track, or control access for this resource.

  • withTags

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

    The tags used to organize, track, or control access for this resource.

    Parameters:

    tags - The tags used to organize, track, or control access for this resource.

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