Class UpdateContactAttributesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.connect.model.ConnectRequest
-
- software.amazon.awssdk.services.connect.model.UpdateContactAttributesRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<UpdateContactAttributesRequest.Builder,UpdateContactAttributesRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateContactAttributesRequest extends ConnectRequest implements ToCopyableBuilder<UpdateContactAttributesRequest.Builder,UpdateContactAttributesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUpdateContactAttributesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>attributes()The Amazon Connect attributes.static UpdateContactAttributesRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAttributes()For responses, this returns true if the service returned a value for the Attributes property.inthashCode()StringinitialContactId()The identifier of the contact.StringinstanceId()The identifier of the Amazon Connect instance.List<SdkField<?>>sdkFields()static Class<? extends UpdateContactAttributesRequest.Builder>serializableBuilderClass()UpdateContactAttributesRequest.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
-
initialContactId
public final String initialContactId()
The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
- Returns:
- The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.
-
instanceId
public final String instanceId()
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- Returns:
- The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
-
hasAttributes
public final boolean hasAttributes()
For responses, this returns true if the service returned a value for the Attributes 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.
-
attributes
public final Map<String,String> attributes()
The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
-
Remove unnecessary attributes by setting their values to empty.
-
If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
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
hasAttributes()method.- Returns:
- The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact
attributes.
You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:
-
Remove unnecessary attributes by setting their values to empty.
-
If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see Flow block: Set contact attributes in the Amazon Connect Administrator Guide.
-
-
-
toBuilder
public UpdateContactAttributesRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UpdateContactAttributesRequest.Builder,UpdateContactAttributesRequest>- Specified by:
toBuilderin classConnectRequest
-
builder
public static UpdateContactAttributesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateContactAttributesRequest.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
-
-