Class KnowledgeBaseSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<KnowledgeBaseSummary.Builder,
KnowledgeBaseSummary>
Summary information about the knowledge base.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic KnowledgeBaseSummary.Builder
builder()
final String
The description of the knowledge base.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The Amazon Resource Name (ARN) of the knowledge base.final String
The identifier of the knowledge base.final KnowledgeBaseType
The type of knowledge base.final String
The type of knowledge base.final String
name()
The name of the knowledge base.final RenderingConfiguration
Information about how to render the content.static Class
<? extends KnowledgeBaseSummary.Builder> The configuration information for the customer managed key used for encryption.final SourceConfiguration
Configuration information about the external data source.final KnowledgeBaseStatus
status()
The status of the knowledge base summary.final String
The status of the knowledge base summary.tags()
The tags used to organize, track, or control access for this resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
description
The description of the knowledge base.
- Returns:
- The description of the knowledge base.
-
knowledgeBaseArn
The Amazon Resource Name (ARN) of the knowledge base.
- Returns:
- The Amazon Resource Name (ARN) of the knowledge base.
-
knowledgeBaseId
The identifier of the knowledge base.
- Returns:
- The identifier of the knowledge base.
-
knowledgeBaseType
The type of knowledge base.
If the service returns an enum value that is not available in the current SDK version,
knowledgeBaseType
will returnKnowledgeBaseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromknowledgeBaseTypeAsString()
.- Returns:
- The type of knowledge base.
- See Also:
-
knowledgeBaseTypeAsString
The type of knowledge base.
If the service returns an enum value that is not available in the current SDK version,
knowledgeBaseType
will returnKnowledgeBaseType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromknowledgeBaseTypeAsString()
.- Returns:
- The type of knowledge base.
- See Also:
-
name
The name of the knowledge base.
- Returns:
- The name of the knowledge base.
-
renderingConfiguration
Information about how to render the content.
- Returns:
- Information about how to render the content.
-
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
, andkms: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
, andkms: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.
-
sourceConfiguration
Configuration information about the external data source.
- Returns:
- Configuration information about the external data source.
-
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 returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the knowledge base summary.
- See Also:
-
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 returnKnowledgeBaseStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the knowledge base summary.
- See Also:
-
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<KnowledgeBaseSummary.Builder,
KnowledgeBaseSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-