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.UpdateContactRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateContactRequest.Builder,UpdateContactRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateContactRequest
extends ConnectRequest
implements ToCopyableBuilder<UpdateContactRequest.Builder,UpdateContactRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdateContactRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static UpdateContactRequest.Builder`	`builder()`
`String`	`contactId()`	The identifier of the contact.
`Endpoint`	`customerEndpoint()`	The endpoint of the customer for which the contact was initiated.
`String`	`description()`	The description of the contact.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasReferences()`	For responses, this returns true if the service returned a value for the References property.
`boolean`	`hasSegmentAttributes()`	For responses, this returns true if the service returned a value for the SegmentAttributes property.
`String`	`instanceId()`	The identifier of the Amazon Connect instance.
`String`	`name()`	The name of the contact.
`QueueInfoInput`	`queueInfo()`	Information about the queue associated with a contact.
`Map<String,Reference>`	`references()`	Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`Map<String,SegmentAttributeValue>`	`segmentAttributes()`	A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map.
`static Class<? extends UpdateContactRequest.Builder>`	`serializableBuilderClass()`
`Endpoint`	`systemEndpoint()`	External system endpoint for the contact was initiated.
`UpdateContactRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UserInfo`	`userInfo()`	Information about the agent associated with a contact.

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
  - 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.
  - contactId
```
public final String contactId()
```
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
    
    Returns:
    
    The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.
  - name
```
public final String name()
```
    The name of the contact.
    
    Returns:
    
    The name of the contact.
  - description
```
public final String description()
```
    The description of the contact.
    
    Returns:
    
    The description of the contact.
  - hasReferences
```
public final boolean hasReferences()
```
    For responses, this returns true if the service returned a value for the References property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - references
```
public final Map<String,Reference> references()
```
    Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
    
    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 hasReferences() method.
    
    Returns:
    
    Well-formed data on contact, shown to agents on Contact Control Panel (CCP).
  - hasSegmentAttributes
```
public final boolean hasSegmentAttributes()
```
    For responses, this returns true if the service returned a value for the SegmentAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - segmentAttributes
```
public final Map<String,SegmentAttributeValue> segmentAttributes()
```
    A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
    
    Attribute keys can include only alphanumeric, -, and _.
    
    This field can be used to show channel subtype, such as connect:Guide.
    
    Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.
    
    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 hasSegmentAttributes() method.
    
    Returns:
    
    A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.
    
    Attribute keys can include only alphanumeric, -, and _.
    
    This field can be used to show channel subtype, such as connect:Guide.
    
    Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.
  - queueInfo
```
public final QueueInfoInput queueInfo()
```
    Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
    
    Returns:
    
    Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
  - userInfo
```
public final UserInfo userInfo()
```
    Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
    
    Returns:
    
    Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
  - customerEndpoint
```
public final Endpoint customerEndpoint()
```
    The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
    
    Returns:
    
    The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
  - systemEndpoint
```
public final Endpoint systemEndpoint()
```
    External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
    
    Returns:
    
    External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.
  - toBuilder
```
public UpdateContactRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateContactRequest.Builder,UpdateContactRequest>
    
    Specified by:
    
    toBuilder in class ConnectRequest
  - builder
```
public static UpdateContactRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateContactRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class UpdateContactRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

instanceId

contactId

name

description

hasReferences

references

hasSegmentAttributes

segmentAttributes

queueInfo

userInfo

customerEndpoint

systemEndpoint

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField