Class CreateContactRequest

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

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

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

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      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.

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      See Also:

    • channelAsString

      public final String channelAsString()

      The channel for the contact.

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      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.

      The CHAT channel is not supported. The following information is incorrect. We're working to correct it.

      See Also:

    • initiationMethod

      public final ContactInitiationMethod initiationMethod()

      Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

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

      Returns:
      Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

      See Also:

    • initiationMethodAsString

      public final String initiationMethodAsString()

      Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

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

      Returns:
      Indicates how the contact was initiated.

      CreateContact only supports the following initiation methods. Valid values by channel are:

      • For VOICE: TRANSFER and the subtype connect:ExternalAudio

      • For EMAIL: OUTBOUND | AGENT_REPLY | FLOW

      • For TASK: API

      The other channels listed below are incorrect. We're working to correct this information.

      See Also:

    • 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

      UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

      Returns:
      User details for the contact

      UserInfo is required when creating an EMAIL contact with OUTBOUND and AGENT_REPLY contact initiation methods.

    • initiateAs

      public final InitiateAs initiateAs()

      Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.

      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. Only TASK channel contacts can be initiated with COMPLETED state.
      See Also:

    • initiateAsAsString

      public final String initiateAsAsString()

      Initial state of the contact when it's created. Only TASK channel contacts can be initiated with COMPLETED state.

      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. Only TASK channel contacts can be initiated with COMPLETED state.
      See Also:

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

    • previousContactId

      public final String previousContactId()

      The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide.

      Returns:
      The ID of the previous contact when creating a transfer contact. This value can be provided only for external audio contacts. For more information, see Integrate Amazon Connect Contact Lens with external voice systems in the Amazon Connect Administrator Guide.

    • toBuilder

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

    • builder

      public static CreateContactRequest.Builder builder()

    • serializableBuilderClass

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