KnowledgeBaseSummary (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.wisdom.model.KnowledgeBaseSummary

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<KnowledgeBaseSummary.Builder,KnowledgeBaseSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class KnowledgeBaseSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBaseSummary.Builder,KnowledgeBaseSummary>

Summary information about the knowledge base.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface KnowledgeBaseSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`KnowledgeBaseSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static KnowledgeBaseSummary.Builder`	`builder()`
`String`	`description()` The 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.
`String`	`knowledgeBaseArn()` The Amazon Resource Name (ARN) of the knowledge base.
`String`	`knowledgeBaseId()` The identifier of the knowledge base.
`KnowledgeBaseType`	`knowledgeBaseType()` The type of knowledge base.
`String`	`knowledgeBaseTypeAsString()` The type of knowledge base.
`String`	`name()` The name of the knowledge base.
`RenderingConfiguration`	`renderingConfiguration()` Information about how to render the content.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends KnowledgeBaseSummary.Builder>`	`serializableBuilderClass()`
`ServerSideEncryptionConfiguration`	`serverSideEncryptionConfiguration()` The configuration information for the customer managed key used for encryption.
`SourceConfiguration`	`sourceConfiguration()` Configuration information about the external data source.
`KnowledgeBaseStatus`	`status()` The status of the knowledge base summary.
`String`	`statusAsString()` The status of the knowledge base summary.
`Map<String,String>`	`tags()` The tags used to organize, track, or control access for this resource.
`KnowledgeBaseSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - description
```
public final String description()
```
    The description of the knowledge base.
    
    Returns:
    
    The description of the knowledge base.
  - knowledgeBaseArn
```
public final String knowledgeBaseArn()
```
    The Amazon Resource Name (ARN) of the knowledge base.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the knowledge base.
  - knowledgeBaseId
```
public final String knowledgeBaseId()
```
    The identifier of the knowledge base.
    
    Returns:
    
    The identifier of the knowledge base.
  - knowledgeBaseType
```
public final KnowledgeBaseType knowledgeBaseType()
```
    The type of knowledge base.
    
    If the service returns an enum value that is not available in the current SDK version, knowledgeBaseType will return KnowledgeBaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseTypeAsString().
    
    Returns:
    
    The type of knowledge base.
    
    See Also:
    
    KnowledgeBaseType
  - knowledgeBaseTypeAsString
```
public final String knowledgeBaseTypeAsString()
```
    The type of knowledge base.
    
    If the service returns an enum value that is not available in the current SDK version, knowledgeBaseType will return KnowledgeBaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from knowledgeBaseTypeAsString().
    
    Returns:
    
    The type of knowledge base.
    
    See Also:
    
    KnowledgeBaseType
  - name
```
public final String name()
```
    The name of the knowledge base.
    
    Returns:
    
    The name of the knowledge base.
  - renderingConfiguration
```
public final RenderingConfiguration renderingConfiguration()
```
    Information about how to render the content.
    
    Returns:
    
    Information about how to render the content.
  - serverSideEncryptionConfiguration
```
public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()
```
    The configuration information for the customer managed key used for encryption.
    
    This KMS key must have a policy that allows kms:CreateGrant and kms:DescribeKey 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 and kms:DescribeKey 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.
  - sourceConfiguration
```
public final SourceConfiguration sourceConfiguration()
```
    Configuration information about the external data source.
    
    Returns:
    
    Configuration information about the external data source.
  - status
```
public final KnowledgeBaseStatus status()
```
    The status of the knowledge base summary.
    
    If the service returns an enum value that is not available in the current SDK version, status will return KnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the knowledge base summary.
    
    See Also:
    
    KnowledgeBaseStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the knowledge base summary.
    
    If the service returns an enum value that is not available in the current SDK version, status will return KnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the knowledge base summary.
    
    See Also:
    
    KnowledgeBaseStatus
  - 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()
```
    The tags used to organize, track, or control access for this resource.
    
    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:
    
    The tags used to organize, track, or control access for this resource.
  - toBuilder
```
public KnowledgeBaseSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<KnowledgeBaseSummary.Builder,KnowledgeBaseSummary>
  - builder
```
public static KnowledgeBaseSummary.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends KnowledgeBaseSummary.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class KnowledgeBaseSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

description

knowledgeBaseArn

knowledgeBaseId

knowledgeBaseType

knowledgeBaseTypeAsString

name

renderingConfiguration

serverSideEncryptionConfiguration

sourceConfiguration

status

statusAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields