software.amazon.awssdk.services.ivsrealtime.model

Class CreateStageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ivsrealtime.model.IvsRealTimeRequest

software.amazon.awssdk.services.ivsrealtime.model.CreateStageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateStageRequest
extends IvsRealTimeRequest
implements ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateStageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateStageRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasParticipantTokenConfigurations() For responses, this returns true if the service returned a value for the ParticipantTokenConfigurations property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() Optional name that can be specified for the stage being created.
List<ParticipantTokenConfiguration>	participantTokenConfigurations() Array of participant token configuration objects to attach to the new stage.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateStageRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Tags attached to the resource.
CreateStageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

name

public final String name()

Optional name that can be specified for the stage being created.

Returns:

Optional name that can be specified for the stage being created.

hasParticipantTokenConfigurations

public final boolean hasParticipantTokenConfigurations()

For responses, this returns true if the service returned a value for the ParticipantTokenConfigurations 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.

participantTokenConfigurations

public final List<ParticipantTokenConfiguration> participantTokenConfigurations()

Array of participant token configuration objects to attach to the new stage.

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 hasParticipantTokenConfigurations() method.

Returns:

Array of participant token configuration objects to attach to the new 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 Tagging AWS Resources 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 Tagging AWS Resources 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.

toBuilder

public CreateStageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Specified by:

toBuilder in class IvsRealTimeRequest

builder

public static CreateStageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo