Class StartAssistantContactRequest

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

  • Method Details

    • instanceId

      public final String instanceId()

      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Returns:
      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

    • aiAgent

      public final AiAgentInput aiAgent()

      The AI agent that participates in the contact.

      Returns:
      The AI agent that participates in the contact.

    • participantDetails

      public final ParticipantDetails participantDetails()

      The display name and other details that identify the chat participant.

      Returns:
      The display name and other details that identify the chat participant.

    • initialMessage

      public final ChatMessage initialMessage()

      The initial message to send to the newly created chat.

      Returns:
      The initial message to send to the newly created chat.

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

    • attributes

      public final Map<String,String> attributes()

      A map of key-value pairs to associate with the contact. Amazon Connect makes these attributes available to flows as standard contact attributes.

      You can provide up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can contain only alphanumeric characters, dashes, and underscores.

      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:
      A map of key-value pairs to associate with the contact. Amazon Connect makes these attributes available to flows as standard contact attributes.

      You can provide up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can contain only alphanumeric characters, dashes, and underscores.

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

    • persistentChat

      public final PersistentChat persistentChat()

      The configuration that enables persistent chat. For more information about persistent chat and its use cases, see Enable persistent chat.

      Returns:
      The configuration that enables persistent chat. For more information about persistent chat and its use cases, see Enable persistent chat.

    • relatedContactId

      public final String relatedContactId()

      The identifier of an Connect Customer contact related to the new assistant contact.

      You cannot provide both RelatedContactId and PersistentChat.

      Returns:
      The identifier of an Connect Customer contact related to the new assistant contact.

      You cannot provide both RelatedContactId and PersistentChat.

    • toBuilder

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

    • builder

      public static StartAssistantContactRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartAssistantContactRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.