Class StartOutboundChatContactRequest

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

  • Method Details

    • sourceEndpoint

      public final Endpoint sourceEndpoint()
      Returns the value of the SourceEndpoint property for this object.
      Returns:
      The value of the SourceEndpoint property for this object.

    • destinationEndpoint

      public final Endpoint destinationEndpoint()
      Returns the value of the DestinationEndpoint property for this object.
      Returns:
      The value of the DestinationEndpoint property for this object.

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

    • 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 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 and connect:SMS.

      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 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 and connect:SMS.

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

      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.

    • contactFlowId

      public final String contactFlowId()

      The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

      • arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 123ec456-a007-89c0-1234-xxxxxxxxxxxx

      Returns:
      The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

      • arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/ 123ec456-a007-89c0-1234-xxxxxxxxxxxx

    • chatDurationInMinutes

      public final Integer chatDurationInMinutes()

      The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

      Returns:
      The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

    • participantDetails

      public final ParticipantDetails participantDetails()
      Returns the value of the ParticipantDetails property for this object.
      Returns:
      The value of the ParticipantDetails property for this object.

    • initialSystemMessage

      public final ChatMessage initialSystemMessage()
      Returns the value of the InitialSystemMessage property for this object.
      Returns:
      The value of the InitialSystemMessage property for this object.

    • relatedContactId

      public final String relatedContactId()

      The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

      Returns:
      The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

    • hasSupportedMessagingContentTypes

      public final boolean hasSupportedMessagingContentTypes()
      For responses, this returns true if the service returned a value for the SupportedMessagingContentTypes 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.

    • supportedMessagingContentTypes

      public final List<String> supportedMessagingContentTypes()

      The supported chat message content types. Supported types are:

      • text/plain

      • text/markdown

      • application/json, application/vnd.amazonaws.connect.message.interactive

      • application/vnd.amazonaws.connect.message.interactive.response

      Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain:

      • [text/plain, text/markdown, application/json]

      • [text/markdown, text/plain]

      • [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]

      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 hasSupportedMessagingContentTypes() method.

      Returns:
      The supported chat message content types. Supported types are:

      • text/plain

      • text/markdown

      • application/json, application/vnd.amazonaws.connect.message.interactive

      • application/vnd.amazonaws.connect.message.interactive.response

      Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain:

      • [text/plain, text/markdown, application/json]

      • [text/markdown, text/plain]

      • [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

    • toBuilder

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

    • builder

      public static StartOutboundChatContactRequest.Builder builder()

    • serializableBuilderClass

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