Event (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Event
extends Object
implements Serializable, Cloneable, StructuredPojo

An occurrence during a stage session.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Event()

Constructors
Constructor and Description
`Event()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Event`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getErrorCode()` If the event is an error event, the error code is provided to give insight into the specific error that occurred.
`Date`	`getEventTime()` ISO 8601 timestamp (returned as a string) for when the event occurred.
`String`	`getName()` The name of the event.
`String`	`getParticipantId()` Unique identifier for the participant who triggered the event.
`String`	`getRemoteParticipantId()` Unique identifier for the remote participant.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setErrorCode(String errorCode)` If the event is an error event, the error code is provided to give insight into the specific error that occurred.
`void`	`setEventTime(Date eventTime)` ISO 8601 timestamp (returned as a string) for when the event occurred.
`void`	`setName(String name)` The name of the event.
`void`	`setParticipantId(String participantId)` Unique identifier for the participant who triggered the event.
`void`	`setRemoteParticipantId(String remoteParticipantId)` Unique identifier for the remote participant.
`String`	`toString()` Returns a string representation of this object.
`Event`	`withErrorCode(EventErrorCode errorCode)` If the event is an error event, the error code is provided to give insight into the specific error that occurred.
`Event`	`withErrorCode(String errorCode)` If the event is an error event, the error code is provided to give insight into the specific error that occurred.
`Event`	`withEventTime(Date eventTime)` ISO 8601 timestamp (returned as a string) for when the event occurred.
`Event`	`withName(EventName name)` The name of the event.
`Event`	`withName(String name)` The name of the event.
`Event`	`withParticipantId(String participantId)` Unique identifier for the participant who triggered the event.
`Event`	`withRemoteParticipantId(String remoteParticipantId)` Unique identifier for the remote participant.

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

- Constructor Detail
  - Event
```
public Event()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the event.
    
    Parameters:
    
    name - The name of the event.
    
    See Also:
    
    EventName
  - getName
```
public String getName()
```
    The name of the event.
    
    Returns:
    
    The name of the event.
    
    See Also:
    
    EventName
  - withName
```
public Event withName(String name)
```
    The name of the event.
    
    Parameters:
    
    name - The name of the event.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventName
  - withName
```
public Event withName(EventName name)
```
    The name of the event.
    
    Parameters:
    
    name - The name of the event.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventName
  - setParticipantId
```
public void setParticipantId(String participantId)
```
    Unique identifier for the participant who triggered the event. This is assigned by IVS.
    
    Parameters:
    
    participantId - Unique identifier for the participant who triggered the event. This is assigned by IVS.
  - getParticipantId
```
public String getParticipantId()
```
    Unique identifier for the participant who triggered the event. This is assigned by IVS.
    
    Returns:
    
    Unique identifier for the participant who triggered the event. This is assigned by IVS.
  - withParticipantId
```
public Event withParticipantId(String participantId)
```
    Unique identifier for the participant who triggered the event. This is assigned by IVS.
    
    Parameters:
    
    participantId - Unique identifier for the participant who triggered the event. This is assigned by IVS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventTime
```
public void setEventTime(Date eventTime)
```
    ISO 8601 timestamp (returned as a string) for when the event occurred.
    
    Parameters:
    
    eventTime - ISO 8601 timestamp (returned as a string) for when the event occurred.
  - getEventTime
```
public Date getEventTime()
```
    ISO 8601 timestamp (returned as a string) for when the event occurred.
    
    Returns:
    
    ISO 8601 timestamp (returned as a string) for when the event occurred.
  - withEventTime
```
public Event withEventTime(Date eventTime)
```
    ISO 8601 timestamp (returned as a string) for when the event occurred.
    
    Parameters:
    
    eventTime - ISO 8601 timestamp (returned as a string) for when the event occurred.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRemoteParticipantId
```
public void setRemoteParticipantId(String remoteParticipantId)
```
    Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
    
    Parameters:
    
    remoteParticipantId - Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
  - getRemoteParticipantId
```
public String getRemoteParticipantId()
```
    Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
    
    Returns:
    
    Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
  - withRemoteParticipantId
```
public Event withRemoteParticipantId(String remoteParticipantId)
```
    Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
    
    Parameters:
    
    remoteParticipantId - Unique identifier for the remote participant. For a subscribe event, this is the publisher. For a publish or join event, this is null. This is assigned by IVS.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    Parameters:
    
    errorCode - If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    See Also:
    
    EventErrorCode
  - getErrorCode
```
public String getErrorCode()
```
    If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    Returns:
    
    If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    See Also:
    
    EventErrorCode
  - withErrorCode
```
public Event withErrorCode(String errorCode)
```
    If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    Parameters:
    
    errorCode - If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventErrorCode
  - withErrorCode
```
public Event withErrorCode(EventErrorCode errorCode)
```
    If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    Parameters:
    
    errorCode - If the event is an error event, the error code is provided to give insight into the specific error that occurred. If the event is not an error event, this field is null. INSUFFICIENT_CAPABILITIES indicates that the participant tried to take an action that the participant’s token is not allowed to do. For more information about participant capabilities, see the capabilities field in CreateParticipantToken. QUOTA_EXCEEDED indicates that the number of participants who want to publish/subscribe to a stage exceeds the quota; for more information, see Service Quotas. PUBLISHER_NOT_FOUND indicates that the participant tried to subscribe to a publisher that doesn’t exist.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EventErrorCode
  - 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 Event 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.777

Class Event

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Event

Method Detail

setName

getName

withName

withName

setParticipantId

getParticipantId

withParticipantId

setEventTime

getEventTime

withEventTime

setRemoteParticipantId

getRemoteParticipantId

withRemoteParticipantId

setErrorCode

getErrorCode

withErrorCode

withErrorCode

toString

equals

hashCode

clone

marshall