Interface StartWebRtcContactRequest.Builder

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

  • Method Details

    • attributes

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

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

      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.

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

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

    • clientToken

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

      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 Amazon Web Services 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.

    • contactFlowId

      StartWebRtcContactRequest.Builder contactFlowId(String contactFlowId)

      The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, 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/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

      Parameters:
      contactFlowId - The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, 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/ 846ec553-a005-41c0-8341-xxxxxxxxxxxx

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

    • instanceId

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

    • allowedCapabilities

      StartWebRtcContactRequest.Builder allowedCapabilities(AllowedCapabilities allowedCapabilities)

      Information about the video sharing capabilities of the participants (customer, agent).

      Parameters:
      allowedCapabilities - Information about the video sharing capabilities of the participants (customer, agent).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • allowedCapabilities

      default StartWebRtcContactRequest.Builder allowedCapabilities(Consumer<AllowedCapabilities.Builder> allowedCapabilities)

      Information about the video sharing capabilities of the participants (customer, agent).

      This is a convenience method that creates an instance of the AllowedCapabilities.Builder avoiding the need to create one manually via AllowedCapabilities.builder().

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

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

    • participantDetails

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

    • relatedContactId

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

    • references

      StartWebRtcContactRequest.Builder references(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 is not a supported reference type during task creation.

      Parameters:
      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 is not a supported reference type during task creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      StartWebRtcContactRequest.Builder description(String description)

      A description of the task that is shown to an agent in the Contact Control Panel (CCP).

      Parameters:
      description - A description of the task that is shown to an agent in the Contact Control Panel (CCP).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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