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

Class CreateContactRequest

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

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

      • relatedContactId

        public final String relatedContactId()

        The identifier of the contact in this instance of Amazon Connect.

        Returns:
        The identifier of the contact in this instance of Amazon Connect.

      • 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 custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

        There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

        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 custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

        There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.

      • 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()

        A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.

        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:
        A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.

      • channel

        public final Channel channel()

        The channel for the contact

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

        Returns:
        The channel for the contact
        See Also:
        Channel

      • channelAsString

        public final String channelAsString()

        The channel for the contact

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

        Returns:
        The channel for the contact
        See Also:
        Channel

      • expiryDurationInMinutes

        public final Integer expiryDurationInMinutes()

        Number of minutes the contact will be active for before expiring

        Returns:
        Number of minutes the contact will be active for before expiring

      • userInfo

        public final UserInfo userInfo()

        User details for the contact

        Returns:
        User details for the contact

      • initiateAs

        public final InitiateAs initiateAs()

        Initial state of the contact when it's created

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

        Returns:
        Initial state of the contact when it's created
        See Also:
        InitiateAs

      • initiateAsAsString

        public final String initiateAsAsString()

        Initial state of the contact when it's created

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

        Returns:
        Initial state of the contact when it's created
        See Also:
        InitiateAs

      • name

        public final String name()

        The name of a the contact.

        Returns:
        The name of a the contact.

      • description

        public final String description()

        A description of the contact.

        Returns:
        A description of the contact.

      • 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 set Segment Contact Expiry as a duration in minutes.

        To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

        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 set Segment Contact Expiry as a duration in minutes.

        To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with SegmentAttributes like { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}.

      • 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