Class Event
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Event.Builder,
Event>
An occurrence during a stage session.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Event.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final EventErrorCode
If the event is an error event, the error code is provided to give insight into the specific error that occurred.final String
If the event is an error event, the error code is provided to give insight into the specific error that occurred.final Instant
ISO 8601 timestamp (returned as a string) for when the event occurred.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final EventName
name()
The name of the event.final String
The name of the event.final String
Unique identifier for the participant who triggered the event.final String
Unique identifier for the remote participant.static Class
<? extends Event.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 thecapabilities
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.If the service returns an enum value that is not available in the current SDK version,
errorCode
will returnEventErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorCodeAsString()
.- 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 thecapabilities
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:
-
errorCodeAsString
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 thecapabilities
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.If the service returns an enum value that is not available in the current SDK version,
errorCode
will returnEventErrorCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromerrorCodeAsString()
.- 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 thecapabilities
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:
-
eventTime
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.
-
name
The name of the event.
If the service returns an enum value that is not available in the current SDK version,
name
will returnEventName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the event.
- See Also:
-
nameAsString
The name of the event.
If the service returns an enum value that is not available in the current SDK version,
name
will returnEventName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromnameAsString()
.- Returns:
- The name of the event.
- See Also:
-
participantId
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.
-
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:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Event.Builder,
Event> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-