ParticipantSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ivsrealtime.model.ParticipantSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ParticipantSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Summary object describing a participant that has joined a stage.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ParticipantSummary()

Constructors
Constructor and Description
`ParticipantSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ParticipantSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getFirstJoinTime()` ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
`String`	`getParticipantId()` Unique identifier for this participant, assigned by IVS.
`Boolean`	`getPublished()` Whether the participant ever published to the stage session.
`String`	`getRecordingState()` The participant’s recording state.
`String`	`getState()` Whether the participant is connected to or disconnected from the stage.
`String`	`getUserId()` 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.
`int`	`hashCode()`
`Boolean`	`isPublished()` Whether the participant ever published to the stage session.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setFirstJoinTime(Date firstJoinTime)` ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
`void`	`setParticipantId(String participantId)` Unique identifier for this participant, assigned by IVS.
`void`	`setPublished(Boolean published)` Whether the participant ever published to the stage session.
`void`	`setRecordingState(String recordingState)` The participant’s recording state.
`void`	`setState(String state)` Whether the participant is connected to or disconnected from the stage.
`void`	`setUserId(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.
`String`	`toString()` Returns a string representation of this object.
`ParticipantSummary`	`withFirstJoinTime(Date firstJoinTime)` ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
`ParticipantSummary`	`withParticipantId(String participantId)` Unique identifier for this participant, assigned by IVS.
`ParticipantSummary`	`withPublished(Boolean published)` Whether the participant ever published to the stage session.
`ParticipantSummary`	`withRecordingState(ParticipantRecordingState recordingState)` The participant’s recording state.
`ParticipantSummary`	`withRecordingState(String recordingState)` The participant’s recording state.
`ParticipantSummary`	`withState(ParticipantState state)` Whether the participant is connected to or disconnected from the stage.
`ParticipantSummary`	`withState(String state)` Whether the participant is connected to or disconnected from the stage.
`ParticipantSummary`	`withUserId(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.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ParticipantSummary
```
public ParticipantSummary()
```
- Method Detail
  - setParticipantId
```
public void setParticipantId(String participantId)
```
    Unique identifier for this participant, assigned by IVS.
    
    Parameters:
    
    participantId - Unique identifier for this participant, assigned by IVS.
  - getParticipantId
```
public String getParticipantId()
```
    Unique identifier for this participant, assigned by IVS.
    
    Returns:
    
    Unique identifier for this participant, assigned by IVS.
  - withParticipantId
```
public ParticipantSummary withParticipantId(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.
  - setUserId
```
public void setUserId(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.
  - getUserId
```
public String getUserId()
```
    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:
    
    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.
  - withUserId
```
public ParticipantSummary withUserId(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.
  - setState
```
public void setState(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.
    
    See Also:
    
    ParticipantState
  - getState
```
public String getState()
```
    Whether the participant is connected to or disconnected from the stage.
    
    Returns:
    
    Whether the participant is connected to or disconnected from the stage.
    
    See Also:
    
    ParticipantState
  - withState
```
public ParticipantSummary withState(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:
    
    ParticipantState
  - withState
```
public ParticipantSummary withState(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:
    
    ParticipantState
  - setFirstJoinTime
```
public void setFirstJoinTime(Date 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.
  - getFirstJoinTime
```
public Date getFirstJoinTime()
```
    ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
    
    Returns:
    
    ISO 8601 timestamp (returned as a string) when the participant first joined the stage session.
  - withFirstJoinTime
```
public ParticipantSummary withFirstJoinTime(Date 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.
  - setPublished
```
public void setPublished(Boolean published)
```
    Whether the participant ever published to the stage session.
    
    Parameters:
    
    published - Whether the participant ever published to the stage session.
  - getPublished
```
public Boolean getPublished()
```
    Whether the participant ever published to the stage session.
    
    Returns:
    
    Whether the participant ever published to the stage session.
  - withPublished
```
public ParticipantSummary withPublished(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.
  - isPublished
```
public Boolean isPublished()
```
    Whether the participant ever published to the stage session.
    
    Returns:
    
    Whether the participant ever published to the stage session.
  - setRecordingState
```
public void setRecordingState(String recordingState)
```
    The participant’s recording state.
    
    Parameters:
    
    recordingState - The participant’s recording state.
    
    See Also:
    
    ParticipantRecordingState
  - getRecordingState
```
public String getRecordingState()
```
    The participant’s recording state.
    
    Returns:
    
    The participant’s recording state.
    
    See Also:
    
    ParticipantRecordingState
  - withRecordingState
```
public ParticipantSummary withRecordingState(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:
    
    ParticipantRecordingState
  - withRecordingState
```
public ParticipantSummary withRecordingState(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:
    
    ParticipantRecordingState
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ParticipantSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.792

Class ParticipantSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ParticipantSummary

Method Detail

setParticipantId

getParticipantId

withParticipantId

setUserId

getUserId

withUserId

setState

getState

withState

withState

setFirstJoinTime

getFirstJoinTime

withFirstJoinTime

setPublished

getPublished

withPublished

isPublished

setRecordingState

getRecordingState

withRecordingState

withRecordingState

toString

equals

hashCode

clone

marshall