Package software.amazon.awssdk.services.ivsrealtime.model

Interface ListParticipantsRequest.Builder

    • Method Detail

      • stageArn

        ListParticipantsRequest.Builder stageArn​(String stageArn)

        Stage ARN.

        Parameters:
        stageArn - Stage ARN.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sessionId

        ListParticipantsRequest.Builder sessionId​(String sessionId)

        ID of the session within the stage.

        Parameters:
        sessionId - ID of the session within the stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterByUserId

        ListParticipantsRequest.Builder filterByUserId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • filterByPublished

        ListParticipantsRequest.Builder filterByPublished​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • filterByState

        ListParticipantsRequest.Builder filterByState​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ParticipantState, ParticipantState

      • filterByState

        ListParticipantsRequest.Builder filterByState​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ParticipantState, ParticipantState

      • nextToken

        ListParticipantsRequest.Builder nextToken​(String nextToken)

        The first participant to retrieve. This is used for pagination; see the nextToken response field.

        Parameters:
        nextToken - The first participant to retrieve. This is used for pagination; see the nextToken response field.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • maxResults

        ListParticipantsRequest.Builder maxResults​(Integer maxResults)

        Maximum number of results to return. Default: 50.

        Parameters:
        maxResults - Maximum number of results to return. Default: 50.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • filterByRecordingState

        ListParticipantsRequest.Builder filterByRecordingState​(String 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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ParticipantRecordingFilterByRecordingState, ParticipantRecordingFilterByRecordingState

      • filterByRecordingState

        ListParticipantsRequest.Builder filterByRecordingState​(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.

        Parameters:
        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.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        ParticipantRecordingFilterByRecordingState, ParticipantRecordingFilterByRecordingState