Class ContentSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ContentSummary.Builder,
ContentSummary>
Summary information about the content.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ContentSummary.Builder
builder()
final String
The Amazon Resource Name (ARN) of the content.final String
The identifier of the content.final String
The media type of the content.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
For responses, this returns true if the service returned a value for the Metadata property.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.metadata()
A key/value map to store attributes without affecting tagging or recommendations.final String
name()
The name of the content.final String
The identifier of the revision of the content.static Class
<? extends ContentSummary.Builder> final ContentStatus
status()
The status of the content.final String
The status of the content.tags()
The tags used to organize, track, or control access for this resource.final String
title()
The title of the content.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
-
contentArn
The Amazon Resource Name (ARN) of the content.
- Returns:
- The Amazon Resource Name (ARN) of the content.
-
contentId
The identifier of the content.
- Returns:
- The identifier of the content.
-
contentType
The media type of the content.
- Returns:
- The media type of the content.
-
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. 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.
-
hasMetadata
public final boolean hasMetadata()For responses, this returns true if the service returned a value for the Metadata 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. -
metadata
A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
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
hasMetadata()
method.- Returns:
- A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
-
name
The name of the content.
- Returns:
- The name of the content.
-
revisionId
The identifier of the revision of the content.
- Returns:
- The identifier of the revision of the content.
-
status
The status of the content.
If the service returns an enum value that is not available in the current SDK version,
status
will returnContentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the content.
- See Also:
-
statusAsString
The status of the content.
If the service returns an enum value that is not available in the current SDK version,
status
will returnContentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the content.
- 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.
-
title
The title of the content.
- Returns:
- The title of the content.
-
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<ContentSummary.Builder,
ContentSummary> - 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
-