Class KnowledgeBaseData
- java.lang.Object
-
- software.amazon.awssdk.services.wisdom.model.KnowledgeBaseData
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<KnowledgeBaseData.Builder,KnowledgeBaseData>
@Generated("software.amazon.awssdk:codegen") public final class KnowledgeBaseData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KnowledgeBaseData.Builder,KnowledgeBaseData>
Information about the knowledge base.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceKnowledgeBaseData.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static KnowledgeBaseData.Builderbuilder()Stringdescription()The description.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringknowledgeBaseArn()The Amazon Resource Name (ARN) of the knowledge base.StringknowledgeBaseId()The identifier of the knowledge base.KnowledgeBaseTypeknowledgeBaseType()The type of knowledge base.StringknowledgeBaseTypeAsString()The type of knowledge base.InstantlastContentModificationTime()An epoch timestamp indicating the most recent content modification inside the knowledge base.Stringname()The name of the knowledge base.RenderingConfigurationrenderingConfiguration()Information about how to render the content.List<SdkField<?>>sdkFields()static Class<? extends KnowledgeBaseData.Builder>serializableBuilderClass()ServerSideEncryptionConfigurationserverSideEncryptionConfiguration()The configuration information for the customer managed key used for encryption.SourceConfigurationsourceConfiguration()Source configuration information about the knowledge base.KnowledgeBaseStatusstatus()The status of the knowledge base.StringstatusAsString()The status of the knowledge base.Map<String,String>tags()The tags used to organize, track, or control access for this resource.KnowledgeBaseData.BuildertoBuilder()StringtoString()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.
- Returns:
- The description.
-
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,
knowledgeBaseTypewill returnKnowledgeBaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromknowledgeBaseTypeAsString().- 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,
knowledgeBaseTypewill returnKnowledgeBaseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromknowledgeBaseTypeAsString().- Returns:
- The type of knowledge base.
- See Also:
KnowledgeBaseType
-
lastContentModificationTime
public final Instant lastContentModificationTime()
An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
- Returns:
- An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
-
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:CreateGrantandkms:DescribeKeypermissions 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:CreateGrantandkms:DescribeKeypermissions 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()
Source configuration information about the knowledge base.
- Returns:
- Source configuration information about the knowledge base.
-
status
public final KnowledgeBaseStatus status()
The status of the knowledge base.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the knowledge base.
- See Also:
KnowledgeBaseStatus
-
statusAsString
public final String statusAsString()
The status of the knowledge base.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the knowledge base.
- 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 theisEmpty()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 KnowledgeBaseData.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<KnowledgeBaseData.Builder,KnowledgeBaseData>
-
builder
public static KnowledgeBaseData.Builder builder()
-
serializableBuilderClass
public static Class<? extends KnowledgeBaseData.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-