Package software.amazon.awssdk.services.connect.model

Class CreatePersistentContactAssociationRequest

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.CreatePersistentContactAssociationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePersistentContactAssociationRequest.Builder,CreatePersistentContactAssociationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePersistentContactAssociationRequest extends ConnectRequest implements ToCopyableBuilder<CreatePersistentContactAssociationRequest.Builder,CreatePersistentContactAssociationRequest>

  • Method Details

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

    • initialContactId

      public final String initialContactId()

      This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.

      Returns:
      This is the contactId of the current contact that the CreatePersistentContactAssociation API is being called from.

    • rehydrationType

      public final RehydrationType rehydrationType()

      The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      If the service returns an enum value that is not available in the current SDK version, rehydrationType will return RehydrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rehydrationTypeAsString().

      Returns:
      The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      See Also:

    • rehydrationTypeAsString

      public final String rehydrationTypeAsString()

      The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      If the service returns an enum value that is not available in the current SDK version, rehydrationType will return RehydrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rehydrationTypeAsString().

      Returns:
      The contactId chosen for rehydration depends on the type chosen.

      • ENTIRE_PAST_SESSION: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the initialContactId of the past ended chat session in the sourceContactId field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat.

      • FROM_SEGMENT: Rehydrates a chat from the specified past chat contact provided in the sourceContactId field.

      The actual contactId used for rehydration is provided in the response of this API.

      To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:

      • Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C2"

          • RehydrationType = "FROM_SEGMENT"

        • Expected behavior

          • This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.

      • Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:

        • Configuration

          • SourceContactId = "C1"

          • RehydrationType = "ENTIRE_PAST_SESSION"

        • Expected behavior

          • This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.

      See Also:

    • sourceContactId

      public final String sourceContactId()

      The contactId from which a persistent chat session must be started.

      Returns:
      The contactId from which a persistent chat session must be started.

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

    • toBuilder

      public CreatePersistentContactAssociationRequest.Builder 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 interface ToCopyableBuilder<CreatePersistentContactAssociationRequest.Builder,CreatePersistentContactAssociationRequest>
      Specified by:
      toBuilder in class ConnectRequest
      Returns:
      a builder for type T

    • builder

      public static CreatePersistentContactAssociationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePersistentContactAssociationRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.