Interface StartCompositionRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<StartCompositionRequest.Builder,StartCompositionRequest>, IvsRealTimeRequest.Builder, SdkBuilder<StartCompositionRequest.Builder,StartCompositionRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartCompositionRequest

@Mutable
@NotThreadSafe
public static interface StartCompositionRequest.Builder
extends IvsRealTimeRequest.Builder, SdkPojo, CopyableBuilder<StartCompositionRequest.Builder,StartCompositionRequest>

Method Summary

Modifier and Type	Method	Description
StartCompositionRequest.Builder	destinations(Collection<DestinationConfiguration> destinations)	Array of destination configuration.
StartCompositionRequest.Builder	destinations(Consumer<DestinationConfiguration.Builder>... destinations)	Array of destination configuration.
StartCompositionRequest.Builder	destinations(DestinationConfiguration... destinations)	Array of destination configuration.
StartCompositionRequest.Builder	idempotencyToken(String idempotencyToken)	Idempotency token.
default StartCompositionRequest.Builder	layout(Consumer<LayoutConfiguration.Builder> layout)	Layout object to configure composition parameters.
StartCompositionRequest.Builder	layout(LayoutConfiguration layout)	Layout object to configure composition parameters.
StartCompositionRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
StartCompositionRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
StartCompositionRequest.Builder	stageArn(String stageArn)	ARN of the stage to be used for compositing.
StartCompositionRequest.Builder	tags(Map<String,String> tags)	Tags attached to the resource.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.ivsrealtime.model.IvsRealTimeRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

stageArn

StartCompositionRequest.Builder stageArn(String stageArn)

ARN of the stage to be used for compositing.

Parameters:

stageArn - ARN of the stage to be used for compositing.

Returns:

Returns a reference to this object so that method calls can be chained together.

idempotencyToken

StartCompositionRequest.Builder idempotencyToken(String idempotencyToken)

Idempotency token.

Parameters:

idempotencyToken - Idempotency token.

Returns:

Returns a reference to this object so that method calls can be chained together.

layout

StartCompositionRequest.Builder layout(LayoutConfiguration layout)

Layout object to configure composition parameters.

Parameters:

layout - Layout object to configure composition parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

layout

default StartCompositionRequest.Builder layout(Consumer<LayoutConfiguration.Builder> layout)

Layout object to configure composition parameters.

This is a convenience method that creates an instance of the LayoutConfiguration.Builder avoiding the need to create one manually via LayoutConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to layout(LayoutConfiguration).

Parameters:

layout - a consumer that will call methods on LayoutConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• layout(LayoutConfiguration)

destinations

StartCompositionRequest.Builder destinations(Collection<DestinationConfiguration> destinations)

Array of destination configuration.

Parameters:

destinations - Array of destination configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinations

StartCompositionRequest.Builder destinations(DestinationConfiguration... destinations)

Array of destination configuration.

Parameters:

destinations - Array of destination configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

destinations

StartCompositionRequest.Builder destinations(Consumer<DestinationConfiguration.Builder>... destinations)

Array of destination configuration.

This is a convenience method that creates an instance of the DestinationConfiguration.Builder avoiding the need to create one manually via DestinationConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinations(List<DestinationConfiguration>).

Parameters:

destinations - a consumer that will call methods on DestinationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• destinations(java.util.Collection<DestinationConfiguration>)

tags

StartCompositionRequest.Builder tags(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

StartCompositionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartCompositionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.