Package software.amazon.awssdk.services.ivsrealtime.model

Interface Event.Builder

    • Method Detail

      • errorCode

        Event.Builder errorCode​(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, EventErrorCode

      • errorCode

        Event.Builder errorCode​(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, EventErrorCode

      • eventTime

        Event.Builder eventTime​(Instant 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

        Event.Builder name​(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, EventName

      • name

        Event.Builder name​(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, EventName

      • participantId

        Event.Builder participantId​(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.

      • remoteParticipantId

        Event.Builder remoteParticipantId​(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.