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

Class Stage

java.lang.Object

software.amazon.awssdk.services.ivsrealtime.model.Stage

All Implemented Interfaces:

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

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

Object specifying a stage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Stage.Builder

Method Summary

Modifier and Type	Method	Description
String	activeSessionId()	ID of the active session within the stage.
String	arn()	Stage ARN.
AutoParticipantRecordingConfiguration	autoParticipantRecordingConfiguration()	Configuration object for individual participant recording, attached to the stage.
static Stage.Builder	builder()
StageEndpoints	endpoints()	Summary information about various endpoints for a stage.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	name()	Stage name.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Stage.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Tags attached to the resource.
Stage.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

arn

public final String arn()

Stage ARN.

Returns:

Stage ARN.

name

public final String name()

Stage name.

Returns:

Stage name.

activeSessionId

public final String activeSessionId()

ID of the active session within the stage.

Returns:

ID of the active session within the stage.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final Map<String,String> tags()

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

autoParticipantRecordingConfiguration

public final AutoParticipantRecordingConfiguration autoParticipantRecordingConfiguration()

Configuration object for individual participant recording, attached to the stage.

Returns:

Configuration object for individual participant recording, attached to the stage.

endpoints

public final StageEndpoints endpoints()

Summary information about various endpoints for a stage.

Returns:

Summary information about various endpoints for a stage.

toBuilder

public Stage.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Stage.Builder,Stage>

builder

public static Stage.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo