Class QuickResponseData
- java.lang.Object
-
- software.amazon.awssdk.services.qconnect.model.QuickResponseData
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<QuickResponseData.Builder,QuickResponseData>
@Generated("software.amazon.awssdk:codegen") public final class QuickResponseData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<QuickResponseData.Builder,QuickResponseData>
Information about the quick response.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceQuickResponseData.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static QuickResponseData.Builderbuilder()List<String>channels()The Amazon Connect contact channels this quick response applies to.QuickResponseContentscontents()The contents of the quick response.StringcontentType()The media type of the quick response content.InstantcreatedTime()The timestamp when the quick response was created.Stringdescription()The description of the quick response.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)GroupingConfigurationgroupingConfiguration()The configuration information of the user groups that the quick response is accessible to.booleanhasChannels()For responses, this returns true if the service returned a value for the Channels property.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.BooleanisActive()Whether the quick response is active.StringknowledgeBaseArn()The Amazon Resource Name (ARN) of the knowledge base.StringknowledgeBaseId()The identifier of the knowledge base.Stringlanguage()The language code value for the language in which the quick response is written.StringlastModifiedBy()The Amazon Resource Name (ARN) of the user who last updated the quick response data.InstantlastModifiedTime()The timestamp when the quick response data was last modified.Stringname()The name of the quick response.StringquickResponseArn()The Amazon Resource Name (ARN) of the quick response.StringquickResponseId()The identifier of the quick response.List<SdkField<?>>sdkFields()static Class<? extends QuickResponseData.Builder>serializableBuilderClass()StringshortcutKey()The shortcut key of the quick response.QuickResponseStatusstatus()The status of the quick response data.StringstatusAsString()The status of the quick response data.Map<String,String>tags()The tags used to organize, track, or control access for this resource.QuickResponseData.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
-
hasChannels
public final boolean hasChannels()
For responses, this returns true if the service returned a value for the Channels 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.
-
channels
public final List<String> channels()
The Amazon Connect contact channels this quick response applies to. The supported contact channel types include
Chat.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
hasChannels()method.- Returns:
- The Amazon Connect contact channels this quick response applies to. The supported contact channel types
include
Chat.
-
contentType
public final String contentType()
The media type of the quick response content.
-
Use
application/x.quickresponse;format=plainfor quick response written in plain text. -
Use
application/x.quickresponse;format=markdownfor quick response written in richtext.
- Returns:
- The media type of the quick response content.
-
Use
application/x.quickresponse;format=plainfor quick response written in plain text. -
Use
application/x.quickresponse;format=markdownfor quick response written in richtext.
-
-
-
contents
public final QuickResponseContents contents()
The contents of the quick response.
- Returns:
- The contents of the quick response.
-
createdTime
public final Instant createdTime()
The timestamp when the quick response was created.
- Returns:
- The timestamp when the quick response was created.
-
description
public final String description()
The description of the quick response.
- Returns:
- The description of the quick response.
-
groupingConfiguration
public final GroupingConfiguration groupingConfiguration()
The configuration information of the user groups that the quick response is accessible to.
- Returns:
- The configuration information of the user groups that the quick response is accessible to.
-
isActive
public final Boolean isActive()
Whether the quick response is active.
- Returns:
- Whether the quick response is active.
-
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. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
- Returns:
- The identifier of the knowledge base. This should not be a QUICK_RESPONSES type knowledge base if you're storing Amazon Q Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
-
language
public final String language()
The language code value for the language in which the quick response is written.
- Returns:
- The language code value for the language in which the quick response is written.
-
lastModifiedBy
public final String lastModifiedBy()
The Amazon Resource Name (ARN) of the user who last updated the quick response data.
- Returns:
- The Amazon Resource Name (ARN) of the user who last updated the quick response data.
-
lastModifiedTime
public final Instant lastModifiedTime()
The timestamp when the quick response data was last modified.
- Returns:
- The timestamp when the quick response data was last modified.
-
name
public final String name()
The name of the quick response.
- Returns:
- The name of the quick response.
-
quickResponseArn
public final String quickResponseArn()
The Amazon Resource Name (ARN) of the quick response.
- Returns:
- The Amazon Resource Name (ARN) of the quick response.
-
quickResponseId
public final String quickResponseId()
The identifier of the quick response.
- Returns:
- The identifier of the quick response.
-
shortcutKey
public final String shortcutKey()
The shortcut key of the quick response. The value should be unique across the knowledge base.
- Returns:
- The shortcut key of the quick response. The value should be unique across the knowledge base.
-
status
public final QuickResponseStatus status()
The status of the quick response data.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnQuickResponseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the quick response data.
- See Also:
QuickResponseStatus
-
statusAsString
public final String statusAsString()
The status of the quick response data.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnQuickResponseStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the quick response data.
- See Also:
QuickResponseStatus
-
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 QuickResponseData.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<QuickResponseData.Builder,QuickResponseData>
-
builder
public static QuickResponseData.Builder builder()
-
serializableBuilderClass
public static Class<? extends QuickResponseData.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.
-
-