Interface StartOutboundChatContactRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<StartOutboundChatContactRequest.Builder,StartOutboundChatContactRequest>, SdkBuilder<StartOutboundChatContactRequest.Builder,StartOutboundChatContactRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartOutboundChatContactRequest
@Mutable @NotThreadSafe public static interface StartOutboundChatContactRequest.Builder extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<StartOutboundChatContactRequest.Builder,StartOutboundChatContactRequest>

  • Method Details

    • sourceEndpoint

      StartOutboundChatContactRequest.Builder sourceEndpoint(Endpoint sourceEndpoint)
      Sets the value of the SourceEndpoint property for this object.
      Parameters:
      sourceEndpoint - The new value for the SourceEndpoint property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceEndpoint

      default StartOutboundChatContactRequest.Builder sourceEndpoint(Consumer<Endpoint.Builder> sourceEndpoint)
      Sets the value of the SourceEndpoint property for this object. This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sourceEndpoint(Endpoint).

      Parameters:
      sourceEndpoint - a consumer that will call methods on Endpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • destinationEndpoint

      StartOutboundChatContactRequest.Builder destinationEndpoint(Endpoint destinationEndpoint)
      Sets the value of the DestinationEndpoint property for this object.
      Parameters:
      destinationEndpoint - The new value for the DestinationEndpoint property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationEndpoint

      default StartOutboundChatContactRequest.Builder destinationEndpoint(Consumer<Endpoint.Builder> destinationEndpoint)
      Sets the value of the DestinationEndpoint property for this object. This is a convenience method that creates an instance of the Endpoint.Builder avoiding the need to create one manually via Endpoint.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinationEndpoint(Endpoint).

      Parameters:
      destinationEndpoint - a consumer that will call methods on Endpoint.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • instanceId

      StartOutboundChatContactRequest.Builder instanceId(String instanceId)

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

      Parameters:
      instanceId - The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • segmentAttributes

      StartOutboundChatContactRequest.Builder segmentAttributes(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attributes

      StartOutboundChatContactRequest.Builder attributes(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • contactFlowId

      StartOutboundChatContactRequest.Builder contactFlowId(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • chatDurationInMinutes

      StartOutboundChatContactRequest.Builder chatDurationInMinutes(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • participantDetails

      StartOutboundChatContactRequest.Builder participantDetails(ParticipantDetails participantDetails)
      Sets the value of the ParticipantDetails property for this object.
      Parameters:
      participantDetails - The new value for the ParticipantDetails property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • participantDetails

      default StartOutboundChatContactRequest.Builder participantDetails(Consumer<ParticipantDetails.Builder> participantDetails)
      Sets the value of the ParticipantDetails property for this object. This is a convenience method that creates an instance of the ParticipantDetails.Builder avoiding the need to create one manually via ParticipantDetails.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to participantDetails(ParticipantDetails).

      Parameters:
      participantDetails - a consumer that will call methods on ParticipantDetails.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initialSystemMessage

      StartOutboundChatContactRequest.Builder initialSystemMessage(ChatMessage initialSystemMessage)
      Sets the value of the InitialSystemMessage property for this object.
      Parameters:
      initialSystemMessage - The new value for the InitialSystemMessage property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • initialSystemMessage

      default StartOutboundChatContactRequest.Builder initialSystemMessage(Consumer<ChatMessage.Builder> initialSystemMessage)
      Sets the value of the InitialSystemMessage property for this object. This is a convenience method that creates an instance of the ChatMessage.Builder avoiding the need to create one manually via ChatMessage.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to initialSystemMessage(ChatMessage).

      Parameters:
      initialSystemMessage - a consumer that will call methods on ChatMessage.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • relatedContactId

      StartOutboundChatContactRequest.Builder relatedContactId(String relatedContactId)

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

      Parameters:
      relatedContactId - The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedMessagingContentTypes

      StartOutboundChatContactRequest.Builder supportedMessagingContentTypes(Collection<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]

      Parameters:
      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]

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedMessagingContentTypes

      StartOutboundChatContactRequest.Builder supportedMessagingContentTypes(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]

      Parameters:
      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]

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartOutboundChatContactRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartOutboundChatContactRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartOutboundChatContactRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.