Class QuickResponseSearchResultData
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<QuickResponseSearchResultData.Builder,
QuickResponseSearchResultData>
The result of quick response search.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionThe user defined contact attributes that are resolved when the search result is returned.The user defined contact attributes that are not resolved when the search result is returned.builder()
channels()
The Amazon Connect contact channels this quick response applies to.final QuickResponseContents
contents()
The contents of the quick response.final String
The media type of the quick response content.final Instant
The timestamp when the quick response was created.final String
The description of the quick response.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 GroupingConfiguration
The configuration information of the user groups that the quick response is accessible to.final boolean
For responses, this returns true if the service returned a value for the AttributesInterpolated property.final boolean
For responses, this returns true if the service returned a value for the AttributesNotInterpolated property.final boolean
For responses, this returns true if the service returned a value for the Channels property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Boolean
isActive()
Whether the quick response is active.final String
The Amazon Resource Name (ARN) of the knowledge base.final String
The identifier of the knowledge base.final String
language()
The language code value for the language in which the quick response is written.final String
The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.final Instant
The timestamp when the quick response search result data was last modified.final String
name()
The name of the quick response.final String
The Amazon Resource Name (ARN) of the quick response.final String
The identifier of the quick response.static Class
<? extends QuickResponseSearchResultData.Builder> final String
The shortcut key of the quick response.final QuickResponseStatus
status()
The resource status of the quick response.final String
The resource status of the quick response.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
-
hasAttributesInterpolated
public final boolean hasAttributesInterpolated()For responses, this returns true if the service returned a value for the AttributesInterpolated 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. -
attributesInterpolated
The user defined contact attributes that are resolved when the search result is returned.
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
hasAttributesInterpolated()
method.- Returns:
- The user defined contact attributes that are resolved when the search result is returned.
-
hasAttributesNotInterpolated
public final boolean hasAttributesNotInterpolated()For responses, this returns true if the service returned a value for the AttributesNotInterpolated 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. -
attributesNotInterpolated
The user defined contact attributes that are not resolved when the search result is returned.
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
hasAttributesNotInterpolated()
method.- Returns:
- The user defined contact attributes that are not resolved when the search result is returned.
-
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
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
The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
- Returns:
- The media type of the quick response content.
-
Use
application/x.quickresponse;format=plain
for quick response written in plain text. -
Use
application/x.quickresponse;format=markdown
for quick response written in richtext.
-
-
-
contents
The contents of the quick response.
- Returns:
- The contents of the quick response.
-
createdTime
The timestamp when the quick response was created.
- Returns:
- The timestamp when the quick response was created.
-
description
The description of the quick response.
- Returns:
- The description of the quick response.
-
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
Whether the quick response is active.
- Returns:
- Whether the quick response is active.
-
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. 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 Wisdom Content resource to it. Can be either the ID or the ARN. URLs cannot contain the ARN.
-
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
The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
- Returns:
- The Amazon Resource Name (ARN) of the user who last updated the quick response search result data.
-
lastModifiedTime
The timestamp when the quick response search result data was last modified.
- Returns:
- The timestamp when the quick response search result data was last modified.
-
name
The name of the quick response.
- Returns:
- The name of the quick response.
-
quickResponseArn
The Amazon Resource Name (ARN) of the quick response.
- Returns:
- The Amazon Resource Name (ARN) of the quick response.
-
quickResponseId
The identifier of the quick response.
- Returns:
- The identifier of the quick response.
-
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
The resource status of the quick response.
If the service returns an enum value that is not available in the current SDK version,
status
will returnQuickResponseStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The resource status of the quick response.
- See Also:
-
statusAsString
The resource status of the quick response.
If the service returns an enum value that is not available in the current SDK version,
status
will returnQuickResponseStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The resource status of the quick response.
- 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<QuickResponseSearchResultData.Builder,
QuickResponseSearchResultData> - 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
-