Interface Event.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Event.Builder,
,Event> SdkBuilder<Event.Builder,
,Event> SdkPojo
- Enclosing class:
Event
-
Method Summary
Modifier and TypeMethodDescriptionIf the event is an error event, the error code is provided to give insight into the specific error that occurred.errorCode
(EventErrorCode errorCode) If the event is an error event, the error code is provided to give insight into the specific error that occurred.ISO 8601 timestamp (returned as a string) for when the event occurred.The name of the event.The name of the event.participantId
(String participantId) Unique identifier for the participant who triggered the event.remoteParticipantId
(String remoteParticipantId) Unique identifier for the remote participant.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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.- 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 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- 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 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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:
-
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:
-
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.
-
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.
-