java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ivsrealtime.model.IvsRealTimeRequest
    - - software.amazon.awssdk.services.ivsrealtime.model.ListParticipantsRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListParticipantsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListParticipantsRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Boolean`	`filterByPublished()`	Filters the response list to only show participants who published during the stage session.
`ParticipantRecordingFilterByRecordingState`	`filterByRecordingState()`	Filters the response list to only show participants with the specified recording state.
`String`	`filterByRecordingStateAsString()`	Filters the response list to only show participants with the specified recording state.
`ParticipantState`	`filterByState()`	Filters the response list to only show participants in the specified state.
`String`	`filterByStateAsString()`	Filters the response list to only show participants in the specified state.
`String`	`filterByUserId()`	Filters the response list to match the specified user ID.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxResults()`	Maximum number of results to return.
`String`	`nextToken()`	The first participant to retrieve.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListParticipantsRequest.Builder>`	`serializableBuilderClass()`
`String`	`sessionId()`	ID of the session within the stage.
`String`	`stageArn()`	Stage ARN.
`ListParticipantsRequest.Builder`	`toBuilder()`
`String`	`toString()`	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
  - stageArn
```
public final String stageArn()
```
    Stage ARN.
    
    Returns:
    
    Stage ARN.
  - sessionId
```
public final String sessionId()
```
    ID of the session within the stage.
    
    Returns:
    
    ID of the session within the stage.
  - filterByUserId
```
public final String filterByUserId()
```
    Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
    
    Returns:
    
    Filters the response list to match the specified user ID. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request. A userId is a customer-assigned name to help identify the token; this can be used to link a participant to a user in the customer’s own systems.
  - filterByPublished
```
public final Boolean filterByPublished()
```
    Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    Returns:
    
    Filters the response list to only show participants who published during the stage session. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
  - filterByState
```
public final ParticipantState filterByState()
```
    Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    If the service returns an enum value that is not available in the current SDK version, filterByState will return ParticipantState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByStateAsString().
    
    Returns:
    
    Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    See Also:
    
    ParticipantState
  - filterByStateAsString
```
public final String filterByStateAsString()
```
    Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    If the service returns an enum value that is not available in the current SDK version, filterByState will return ParticipantState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByStateAsString().
    
    Returns:
    
    Filters the response list to only show participants in the specified state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    See Also:
    
    ParticipantState
  - nextToken
```
public final String nextToken()
```
    The first participant to retrieve. This is used for pagination; see the nextToken response field.
    
    Returns:
    
    The first participant to retrieve. This is used for pagination; see the nextToken response field.
  - maxResults
```
public final Integer maxResults()
```
    Maximum number of results to return. Default: 50.
    
    Returns:
    
    Maximum number of results to return. Default: 50.
  - filterByRecordingState
```
public final ParticipantRecordingFilterByRecordingState filterByRecordingState()
```
    Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    If the service returns an enum value that is not available in the current SDK version, filterByRecordingState will return ParticipantRecordingFilterByRecordingState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByRecordingStateAsString().
    
    Returns:
    
    Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    See Also:
    
    ParticipantRecordingFilterByRecordingState
  - filterByRecordingStateAsString
```
public final String filterByRecordingStateAsString()
```
    Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    If the service returns an enum value that is not available in the current SDK version, filterByRecordingState will return ParticipantRecordingFilterByRecordingState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterByRecordingStateAsString().
    
    Returns:
    
    Filters the response list to only show participants with the specified recording state. Only one of filterByUserId, filterByPublished, filterByState, or filterByRecordingState can be provided per request.
    
    See Also:
    
    ParticipantRecordingFilterByRecordingState
  - toBuilder
```
public ListParticipantsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListParticipantsRequest.Builder,ListParticipantsRequest>
    
    Specified by:
    
    toBuilder in class IvsRealTimeRequest
  - builder
```
public static ListParticipantsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListParticipantsRequest.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class ListParticipantsRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

stageArn

sessionId

filterByUserId

filterByPublished

filterByState

filterByStateAsString

nextToken

maxResults

filterByRecordingState

filterByRecordingStateAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField