Class CreateMessageTemplateRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.qconnect.model.QConnectRequest
-
- software.amazon.awssdk.services.qconnect.model.CreateMessageTemplateRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateMessageTemplateRequest.Builder,CreateMessageTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateMessageTemplateRequest extends QConnectRequest implements ToCopyableBuilder<CreateMessageTemplateRequest.Builder,CreateMessageTemplateRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateMessageTemplateRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateMessageTemplateRequest.Builderbuilder()ChannelSubtypechannelSubtype()The channel subtype this message template applies to.StringchannelSubtypeAsString()The channel subtype this message template applies to.StringclientToken()A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.MessageTemplateContentProvidercontent()The content of the message template.MessageTemplateAttributesdefaultAttributes()An object that specifies the default values to use for variables in the message template.Stringdescription()The description of the message template.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)GroupingConfigurationgroupingConfiguration()Returns the value of the GroupingConfiguration property for this object.inthashCode()booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringknowledgeBaseId()The identifier of the knowledge base.Stringlanguage()The language code value for the language in which the quick response is written.Stringname()The name of the message template.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateMessageTemplateRequest.Builder>serializableBuilderClass()Map<String,String>tags()The tags used to organize, track, or control access for this resource.CreateMessageTemplateRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
channelSubtype
public final ChannelSubtype channelSubtype()
The channel subtype this message template applies to.
If the service returns an enum value that is not available in the current SDK version,
channelSubtypewill returnChannelSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromchannelSubtypeAsString().- Returns:
- The channel subtype this message template applies to.
- See Also:
ChannelSubtype
-
channelSubtypeAsString
public final String channelSubtypeAsString()
The channel subtype this message template applies to.
If the service returns an enum value that is not available in the current SDK version,
channelSubtypewill returnChannelSubtype.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromchannelSubtypeAsString().- Returns:
- The channel subtype this message template applies to.
- See Also:
ChannelSubtype
-
clientToken
public final String clientToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
-
content
public final MessageTemplateContentProvider content()
The content of the message template.
- Returns:
- The content of the message template.
-
defaultAttributes
public final MessageTemplateAttributes defaultAttributes()
An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
- Returns:
- An object that specifies the default values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. The corresponding value defines the default value for that variable.
-
description
public final String description()
The description of the message template.
- Returns:
- The description of the message template.
-
groupingConfiguration
public final GroupingConfiguration groupingConfiguration()
Returns the value of the GroupingConfiguration property for this object.- Returns:
- The value of the GroupingConfiguration property for this object.
-
knowledgeBaseId
public final String knowledgeBaseId()
The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
- Returns:
- The identifier of the knowledge base. 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. The supported language codes include
de_DE,en_US,es_ES,fr_FR,id_ID,it_IT,ja_JP,ko_KR,pt_BR,zh_CN,zh_TW- Returns:
- The language code value for the language in which the quick response is written. The supported language
codes include
de_DE,en_US,es_ES,fr_FR,id_ID,it_IT,ja_JP,ko_KR,pt_BR,zh_CN,zh_TW
-
name
public final String name()
The name of the message template.
- Returns:
- The name of the message template.
-
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 CreateMessageTemplateRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateMessageTemplateRequest.Builder,CreateMessageTemplateRequest>- Specified by:
toBuilderin classQConnectRequest
-
builder
public static CreateMessageTemplateRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateMessageTemplateRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-