Interface ParticipantSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ParticipantSummary.Builder,ParticipantSummary>, SdkBuilder<ParticipantSummary.Builder,ParticipantSummary>, SdkPojo
Enclosing class:
ParticipantSummary
@Mutable @NotThreadSafe public static interface ParticipantSummary.Builder extends SdkPojo, CopyableBuilder<ParticipantSummary.Builder,ParticipantSummary>

  • Method Details

    • participantId

      ParticipantSummary.Builder participantId(String participantId)

      Unique identifier for this participant, assigned by IVS.

      Parameters:
      participantId - Unique identifier for this participant, assigned by IVS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      ParticipantSummary.Builder userId(String userId)

      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. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

      Parameters:
      userId - 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. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      ParticipantSummary.Builder state(String state)

      Whether the participant is connected to or disconnected from the stage.

      Parameters:
      state - Whether the participant is connected to or disconnected from the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • state

      ParticipantSummary.Builder state(ParticipantState state)

      Whether the participant is connected to or disconnected from the stage.

      Parameters:
      state - Whether the participant is connected to or disconnected from the stage.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • firstJoinTime

      ParticipantSummary.Builder firstJoinTime(Instant firstJoinTime)

      ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.

      Parameters:
      firstJoinTime - ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • published

      ParticipantSummary.Builder published(Boolean published)

      Whether the participant ever published to the stage session.

      Parameters:
      published - Whether the participant ever published to the stage session.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • recordingState

      ParticipantSummary.Builder recordingState(String recordingState)

      The participant’s recording state.

      Parameters:
      recordingState - The participant’s recording state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • recordingState

      ParticipantSummary.Builder recordingState(ParticipantRecordingState recordingState)

      The participant’s recording state.

      Parameters:
      recordingState - The participant’s recording state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationType

      ParticipantSummary.Builder replicationType(String replicationType)

      Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

      Parameters:
      replicationType - Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationType

      ParticipantSummary.Builder replicationType(ReplicationType replicationType)

      Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.

      Parameters:
      replicationType - Indicates if the participant has been replicated to another stage or is a replica from another stage. Default: NONE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationState

      ParticipantSummary.Builder replicationState(String replicationState)

      The participant's replication state.

      Parameters:
      replicationState - The participant's replication state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicationState

      ParticipantSummary.Builder replicationState(ReplicationState replicationState)

      The participant's replication state.

      Parameters:
      replicationState - The participant's replication state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceStageArn

      ParticipantSummary.Builder sourceStageArn(String sourceStageArn)

      ARN of the stage from which this participant is replicated.

      Parameters:
      sourceStageArn - ARN of the stage from which this participant is replicated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceSessionId

      ParticipantSummary.Builder sourceSessionId(String sourceSessionId)

      ID of the session within the source stage, if replicationType is REPLICA.

      Parameters:
      sourceSessionId - ID of the session within the source stage, if replicationType is REPLICA.
      Returns:
      Returns a reference to this object so that method calls can be chained together.