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

Class StartCompositionRequest

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.StartCompositionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartCompositionRequest.Builder,StartCompositionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartCompositionRequest.Builder

Method Summary

Modifier and Type	Method	Description
static StartCompositionRequest.Builder	builder()
List<DestinationConfiguration>	destinations()	Array of destination configuration.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDestinations()	For responses, this returns true if the service returned a value for the Destinations property.
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
String	idempotencyToken()	Idempotency token.
LayoutConfiguration	layout()	Layout object to configure composition parameters.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StartCompositionRequest.Builder>	serializableBuilderClass()
String	stageArn()	ARN of the stage to be used for compositing.
Map<String,String>	tags()	Tags attached to the resource.
StartCompositionRequest.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

stageArn

public final String stageArn()

ARN of the stage to be used for compositing.

Returns:

ARN of the stage to be used for compositing.

idempotencyToken

public final String idempotencyToken()

Idempotency token.

Returns:

Idempotency token.

layout

public final LayoutConfiguration layout()

Layout object to configure composition parameters.

Returns:

Layout object to configure composition parameters.

hasDestinations

public final boolean hasDestinations()

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

destinations

public final List<DestinationConfiguration> destinations()

Array of destination configuration.

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

Returns:

Array of destination configuration.

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.

toBuilder

public StartCompositionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartCompositionRequest.Builder,StartCompositionRequest>

Specified by:

toBuilder in class IvsRealTimeRequest

builder

public static StartCompositionRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo