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

Class StageSession

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.StageSession

All Implemented Interfaces:

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

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

A stage session begins when the first participant joins a stage and ends after the last participant leaves the stage. A stage session helps with debugging stages by grouping events and participants into shorter periods of time (i.e., a session), which is helpful when stages are used over long periods of time.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StageSession.Builder

Method Summary

Modifier and Type	Method	Description
static StageSession.Builder	builder()
Instant	endTime()	ISO 8601 timestamp (returned as a string) when the stage session ended.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends StageSession.Builder>	serializableBuilderClass()
String	sessionId()	ID of the session within the stage.
Instant	startTime()	ISO 8601 timestamp (returned as a string) when this stage session began.
StageSession.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

endTime

public final Instant endTime()

ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.

Returns:

ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if the stage is active.

sessionId

public final String sessionId()

ID of the session within the stage.

Returns:

ID of the session within the stage.

startTime

public final Instant startTime()

ISO 8601 timestamp (returned as a string) when this stage session began.

Returns:

ISO 8601 timestamp (returned as a string) when this stage session began.

toBuilder

public StageSession.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StageSession.Builder,StageSession>

builder

public static StageSession.Builder builder()

serializableBuilderClass

public static Class<? extends StageSession.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