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

Interface CreateParticipantRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, ConnectRequest.Builder, CopyableBuilder<CreateParticipantRequest.Builder,CreateParticipantRequest>, SdkBuilder<CreateParticipantRequest.Builder,CreateParticipantRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateParticipantRequest

public static interface CreateParticipantRequest.Builder
extends ConnectRequest.Builder, SdkPojo, CopyableBuilder<CreateParticipantRequest.Builder,CreateParticipantRequest>

Method Summary

Modifier and Type	Method	Description
CreateParticipantRequest.Builder	clientToken(String clientToken)	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateParticipantRequest.Builder	contactId(String contactId)	The identifier of the contact in this instance of Amazon Connect.
CreateParticipantRequest.Builder	instanceId(String instanceId)	The identifier of the Amazon Connect instance.
CreateParticipantRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateParticipantRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreateParticipantRequest.Builder	participantDetails(Consumer<ParticipantDetailsToAdd.Builder> participantDetails)	Information identifying the participant.
CreateParticipantRequest.Builder	participantDetails(ParticipantDetailsToAdd participantDetails)	Information identifying the participant.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.services.connect.model.ConnectRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

instanceId

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

contactId

CreateParticipantRequest.Builder contactId(String contactId)

The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

Parameters:

contactId - The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.

Returns:

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

clientToken

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

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.

Returns:

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

participantDetails

CreateParticipantRequest.Builder participantDetails(ParticipantDetailsToAdd participantDetails)

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

Parameters:

participantDetails - Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

Returns:

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

participantDetails

default CreateParticipantRequest.Builder participantDetails(Consumer<ParticipantDetailsToAdd.Builder> participantDetails)

Information identifying the participant.

The only Valid value for ParticipantRole is CUSTOM_BOT.

DisplayName is Required.

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

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

Parameters:

participantDetails - a consumer that will call methods on ParticipantDetailsToAdd.Builder

Returns:

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

See Also:

• participantDetails(ParticipantDetailsToAdd)

overrideConfiguration

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

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