Package software.amazon.awssdk.services.ivs.model

Class StreamEvent

java.lang.Object

software.amazon.awssdk.services.ivs.model.StreamEvent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<StreamEvent.Builder,StreamEvent>

@Generated("software.amazon.awssdk:codegen")
public final class StreamEvent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StreamEvent.Builder,StreamEvent>

Object specifying a stream’s events. For a list of events, see Using Amazon EventBridge with Amazon IVS.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StreamEvent.Builder

Method Summary

Modifier and Type	Method	Description
static StreamEvent.Builder	builder()
String	code()	Provides additional details about the stream event.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	eventTime()	Time when the event occurred.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	Name that identifies the stream event within a type.
List<SdkField<?>>	sdkFields()
static Class<? extends StreamEvent.Builder>	serializableBuilderClass()
StreamEvent.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	Logical group for certain events.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

code

public final String code()

Provides additional details about the stream event. There are several values; note that the long descriptions are provided in the IVS console but not delivered through the IVS API or EventBridge:

• StreamTakeoverMediaMismatch — The broadcast client attempted to take over with different media properties (e.g., codec, resolution, or video track type) from the original stream.

• StreamTakeoverInvalidPriority — The broadcast client attempted a takeover with either a priority integer value equal to or lower than the original stream's value or a value outside the allowed range of 1 to 2,147,483,647.

• StreamTakeoverLimitBreached — The broadcast client reached the maximum allowed takeover attempts for this stream.

Returns:

Provides additional details about the stream event. There are several values; note that the long descriptions are provided in the IVS console but not delivered through the IVS API or EventBridge:

• StreamTakeoverMediaMismatch — The broadcast client attempted to take over with different media properties (e.g., codec, resolution, or video track type) from the original stream.

• StreamTakeoverInvalidPriority — The broadcast client attempted a takeover with either a priority integer value equal to or lower than the original stream's value or a value outside the allowed range of 1 to 2,147,483,647.

• StreamTakeoverLimitBreached — The broadcast client reached the maximum allowed takeover attempts for this stream.

eventTime

public final Instant eventTime()

Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.

Returns:

Time when the event occurred. This is an ISO 8601 timestamp; note that this is returned as a string.

name

public final String name()

Name that identifies the stream event within a type.

Returns:

Name that identifies the stream event within a type.

type

public final String type()

Logical group for certain events.

Returns:

Logical group for certain events.

toBuilder

public StreamEvent.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StreamEvent.Builder,StreamEvent>

builder

public static StreamEvent.Builder builder()

serializableBuilderClass

public static Class<? extends StreamEvent.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo