Package software.amazon.awssdk.services.connectparticipant.model

Class CreateParticipantConnectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.connectparticipant.model.ConnectParticipantRequest

software.amazon.awssdk.services.connectparticipant.model.CreateParticipantConnectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateParticipantConnectionRequest.Builder,CreateParticipantConnectionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateParticipantConnectionRequest
extends ConnectParticipantRequest
implements ToCopyableBuilder<CreateParticipantConnectionRequest.Builder,CreateParticipantConnectionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateParticipantConnectionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateParticipantConnectionRequest.Builder	builder()
Boolean	connectParticipant()	Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasType()	For responses, this returns true if the service returned a value for the Type property.
String	participantToken()	This is a header parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateParticipantConnectionRequest.Builder>	serializableBuilderClass()
CreateParticipantConnectionRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<ConnectionType>	type()	Type of connection information required.
List<String>	typeAsStrings()	Type of connection information required.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

type

public final List<ConnectionType> type()

Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.

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

Returns:

Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.

hasType

public final boolean hasType()

For responses, this returns true if the service returned a value for the Type 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.

typeAsStrings

public final List<String> typeAsStrings()

Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.

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

Returns:

Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.

participantToken

public final String participantToken()

This is a header parameter.

The ParticipantToken as obtained from StartChatContact API response.

Returns:

This is a header parameter.

The ParticipantToken as obtained from StartChatContact API response.

connectParticipant

public final Boolean connectParticipant()

Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.

Returns:

Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.

toBuilder

public CreateParticipantConnectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateParticipantConnectionRequest.Builder,CreateParticipantConnectionRequest>

Specified by:

toBuilder in class ConnectParticipantRequest

builder

public static CreateParticipantConnectionRequest.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo