KnowledgeBaseSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.connectwisdom.model.KnowledgeBaseSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class KnowledgeBaseSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Summary information about the knowledge base.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

KnowledgeBaseSummary()

Constructors
Constructor and Description
`KnowledgeBaseSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KnowledgeBaseSummary`	`addTagsEntry(String key, String value)` Add a single Tags entry
`KnowledgeBaseSummary`	`clearTagsEntries()` Removes all the entries added into Tags.
`KnowledgeBaseSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The description of the knowledge base.
`String`	`getKnowledgeBaseArn()` The Amazon Resource Name (ARN) of the knowledge base.
`String`	`getKnowledgeBaseId()` The identifier of the knowledge base.
`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()` Configuration information about the external data source.
`String`	`getStatus()` The status of the knowledge base summary.
`Map<String,String>`	`getTags()` The tags used to organize, track, or control access for this resource.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDescription(String description)` The description of the knowledge base.
`void`	`setKnowledgeBaseArn(String knowledgeBaseArn)` The Amazon Resource Name (ARN) of the knowledge base.
`void`	`setKnowledgeBaseId(String knowledgeBaseId)` The identifier of the knowledge base.
`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)` Configuration information about the external data source.
`void`	`setStatus(String status)` The status of the knowledge base summary.
`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.
`KnowledgeBaseSummary`	`withDescription(String description)` The description of the knowledge base.
`KnowledgeBaseSummary`	`withKnowledgeBaseArn(String knowledgeBaseArn)` The Amazon Resource Name (ARN) of the knowledge base.
`KnowledgeBaseSummary`	`withKnowledgeBaseId(String knowledgeBaseId)` The identifier of the knowledge base.
`KnowledgeBaseSummary`	`withKnowledgeBaseType(KnowledgeBaseType knowledgeBaseType)` The type of knowledge base.
`KnowledgeBaseSummary`	`withKnowledgeBaseType(String knowledgeBaseType)` The type of knowledge base.
`KnowledgeBaseSummary`	`withName(String name)` The name of the knowledge base.
`KnowledgeBaseSummary`	`withRenderingConfiguration(RenderingConfiguration renderingConfiguration)` Information about how to render the content.
`KnowledgeBaseSummary`	`withServerSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)` The configuration information for the customer managed key used for encryption.
`KnowledgeBaseSummary`	`withSourceConfiguration(SourceConfiguration sourceConfiguration)` Configuration information about the external data source.
`KnowledgeBaseSummary`	`withStatus(KnowledgeBaseStatus status)` The status of the knowledge base summary.
`KnowledgeBaseSummary`	`withStatus(String status)` The status of the knowledge base summary.
`KnowledgeBaseSummary`	`withTags(Map<String,String> tags)` The tags used to organize, track, or control access for this resource.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - KnowledgeBaseSummary
```
public KnowledgeBaseSummary()
```
- Method Detail
  - setDescription
```
public void setDescription(String description)
```
    The description of the knowledge base.
    
    Parameters:
    
    description - The description of the knowledge base.
  - getDescription
```
public String getDescription()
```
    The description of the knowledge base.
    
    Returns:
    
    The description of the knowledge base.
  - withDescription
```
public KnowledgeBaseSummary withDescription(String description)
```
    The description of the knowledge base.
    
    Parameters:
    
    description - The description of the knowledge base.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKnowledgeBaseArn
```
public void setKnowledgeBaseArn(String knowledgeBaseArn)
```
    The Amazon Resource Name (ARN) of the knowledge base.
    
    Parameters:
    
    knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
  - getKnowledgeBaseArn
```
public String getKnowledgeBaseArn()
```
    The Amazon Resource Name (ARN) of the knowledge base.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - withKnowledgeBaseArn
```
public KnowledgeBaseSummary withKnowledgeBaseArn(String knowledgeBaseArn)
```
    The Amazon Resource Name (ARN) of the knowledge base.
    
    Parameters:
    
    knowledgeBaseArn - The Amazon Resource Name (ARN) of the knowledge base.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKnowledgeBaseId
```
public void setKnowledgeBaseId(String knowledgeBaseId)
```
    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
    
    Parameters:
    
    knowledgeBaseId - The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
  - getKnowledgeBaseId
```
public String getKnowledgeBaseId()
```
    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
    
    Returns:
    
    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
  - withKnowledgeBaseId
```
public KnowledgeBaseSummary withKnowledgeBaseId(String knowledgeBaseId)
```
    The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
    
    Parameters:
    
    knowledgeBaseId - The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Wisdom Content resource to it.
    
    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.
    
    Parameters:
    
    knowledgeBaseType - The type of knowledge base.
    
    See Also:
    
    KnowledgeBaseType
  - getKnowledgeBaseType
```
public String getKnowledgeBaseType()
```
    The type of knowledge base.
    
    Returns:
    
    The type of knowledge base.
    
    See Also:
    
    KnowledgeBaseType
  - withKnowledgeBaseType
```
public KnowledgeBaseSummary withKnowledgeBaseType(String knowledgeBaseType)
```
    The type of knowledge base.
    
    Parameters:
    
    knowledgeBaseType - The type of knowledge base.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KnowledgeBaseType
  - withKnowledgeBaseType
```
public KnowledgeBaseSummary withKnowledgeBaseType(KnowledgeBaseType knowledgeBaseType)
```
    The type of knowledge base.
    
    Parameters:
    
    knowledgeBaseType - The type of knowledge base.
    
    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 KnowledgeBaseSummary 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 KnowledgeBaseSummary 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/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
    
    For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom 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/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
    
    For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom 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/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
    
    For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom 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/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
    
    For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
  - withServerSideEncryptionConfiguration
```
public KnowledgeBaseSummary 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/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
    
    For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom 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/kms:GenerateDataKey permissions to the IAM identity using the key to invoke Wisdom.
    
    For more information about setting up a customer managed key for Wisdom, see Enable Amazon Connect Wisdom for your instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceConfiguration
```
public void setSourceConfiguration(SourceConfiguration sourceConfiguration)
```
    Configuration information about the external data source.
    
    Parameters:
    
    sourceConfiguration - Configuration information about the external data source.
  - getSourceConfiguration
```
public SourceConfiguration getSourceConfiguration()
```
    Configuration information about the external data source.
    
    Returns:
    
    Configuration information about the external data source.
  - withSourceConfiguration
```
public KnowledgeBaseSummary withSourceConfiguration(SourceConfiguration sourceConfiguration)
```
    Configuration information about the external data source.
    
    Parameters:
    
    sourceConfiguration - Configuration information about the external data source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The status of the knowledge base summary.
    
    Parameters:
    
    status - The status of the knowledge base summary.
    
    See Also:
    
    KnowledgeBaseStatus
  - getStatus
```
public String getStatus()
```
    The status of the knowledge base summary.
    
    Returns:
    
    The status of the knowledge base summary.
    
    See Also:
    
    KnowledgeBaseStatus
  - withStatus
```
public KnowledgeBaseSummary withStatus(String status)
```
    The status of the knowledge base summary.
    
    Parameters:
    
    status - The status of the knowledge base summary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KnowledgeBaseStatus
  - withStatus
```
public KnowledgeBaseSummary withStatus(KnowledgeBaseStatus status)
```
    The status of the knowledge base summary.
    
    Parameters:
    
    status - The status of the knowledge base summary.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    KnowledgeBaseStatus
  - 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 KnowledgeBaseSummary 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 KnowledgeBaseSummary addTagsEntry(String key,
                                         String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public KnowledgeBaseSummary 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 KnowledgeBaseSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class KnowledgeBaseSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KnowledgeBaseSummary

Method Detail

setDescription

getDescription

withDescription

setKnowledgeBaseArn

getKnowledgeBaseArn

withKnowledgeBaseArn

setKnowledgeBaseId

getKnowledgeBaseId

withKnowledgeBaseId

setKnowledgeBaseType

getKnowledgeBaseType

withKnowledgeBaseType

withKnowledgeBaseType

setName

getName

withName

setRenderingConfiguration

getRenderingConfiguration

withRenderingConfiguration

setServerSideEncryptionConfiguration

getServerSideEncryptionConfiguration

withServerSideEncryptionConfiguration

setSourceConfiguration

getSourceConfiguration

withSourceConfiguration

setStatus

getStatus

withStatus

withStatus

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

toString

equals

hashCode

clone

marshall