Class CreateAttendeeRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.chimesdkmeetings.model.ChimeSdkMeetingsRequest
-
- software.amazon.awssdk.services.chimesdkmeetings.model.CreateAttendeeRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAttendeeRequest extends ChimeSdkMeetingsRequest implements ToCopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateAttendeeRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateAttendeeRequest.Builderbuilder()AttendeeCapabilitiescapabilities()The capabilities (audio,video, orcontent) that you want to grant an attendee.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringexternalUserId()The Amazon Chime SDK external user ID.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringmeetingId()The unique ID of the meeting.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateAttendeeRequest.Builder>serializableBuilderClass()CreateAttendeeRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
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
-
meetingId
public final String meetingId()
The unique ID of the meeting.
- Returns:
- The unique ID of the meeting.
-
externalUserId
public final String externalUserId()
The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by a builder application.
Pattern:
[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*Values that begin with
aws:are reserved. You can't configure a value that uses this prefix.- Returns:
- The Amazon Chime SDK external user ID. An idempotency token. Links the attendee to an identity managed by
a builder application.
Pattern:
[-_&@+=,(){}\[\]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*Values that begin with
aws:are reserved. You can't configure a value that uses this prefix.
-
capabilities
public final AttendeeCapabilities capabilities()
The capabilities (
audio,video, orcontent) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
- Returns:
- The capabilities (
audio,video, orcontent) that you want to grant an attendee. If you don't specify capabilities, all users have send and receive capabilities on all media channels by default.You use the capabilities with a set of values that control what the capabilities can do, such as
SendReceivedata. For more information about those values, see .When using capabilities, be aware of these corner cases:
-
If you specify
MeetingFeatures:Video:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Videowill be rejected withValidationError 400. -
If you specify
MeetingFeatures:Content:MaxResolution:Nonewhen you create a meeting, all API requests that includeSendReceive,Send, orReceiveforAttendeeCapabilities:Contentwill be rejected withValidationError 400. -
You can't set
contentcapabilities toSendReceiveorReceiveunless you also setvideocapabilities toSendReceiveorReceive. If you don't set thevideocapability to receive, the response will contain an HTTP 400 Bad Request status code. However, you can set yourvideocapability to receive and you set yourcontentcapability to not receive. -
When you change an
audiocapability fromNoneorReceivetoSendorSendReceive, and if the attendee left their microphone unmuted, audio will flow from the attendee to the other meeting participants. -
When you change a
videoorcontentcapability fromNoneorReceivetoSendorSendReceive, and if the attendee turned on their video or content streams, remote attendees can receive those streams, but only after media renegotiation between the client and the Amazon Chime back-end server.
-
-
-
toBuilder
public CreateAttendeeRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateAttendeeRequest.Builder,CreateAttendeeRequest>- Specified by:
toBuilderin classChimeSdkMeetingsRequest
-
builder
public static CreateAttendeeRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateAttendeeRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-