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

Interface CompositionSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<CompositionSummary.Builder,CompositionSummary>, SdkBuilder<CompositionSummary.Builder,CompositionSummary>, SdkPojo

Enclosing class:

CompositionSummary

public static interface CompositionSummary.Builder
extends SdkPojo, CopyableBuilder<CompositionSummary.Builder,CompositionSummary>

Method Summary

Modifier and Type	Method	Description
CompositionSummary.Builder	arn(String arn)	ARN of the Composition resource.
CompositionSummary.Builder	destinations(Collection<DestinationSummary> destinations)	Array of Destination objects.
CompositionSummary.Builder	destinations(Consumer<DestinationSummary.Builder>... destinations)	Array of Destination objects.
CompositionSummary.Builder	destinations(DestinationSummary... destinations)	Array of Destination objects.
CompositionSummary.Builder	endTime(Instant endTime)	UTC time of the Composition end.
CompositionSummary.Builder	stageArn(String stageArn)	ARN of the attached stage.
CompositionSummary.Builder	startTime(Instant startTime)	UTC time of the Composition start.
CompositionSummary.Builder	state(String state)	State of the Composition resource.
CompositionSummary.Builder	state(CompositionState state)	State of the Composition resource.
CompositionSummary.Builder	tags(Map<String,String> tags)	Tags attached to the resource.

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

copy

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 Detail

arn

CompositionSummary.Builder arn(String arn)

ARN of the Composition resource.

Parameters:

arn - ARN of the Composition resource.

Returns:

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

stageArn

CompositionSummary.Builder stageArn(String stageArn)

ARN of the attached stage.

Parameters:

stageArn - ARN of the attached stage.

Returns:

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

destinations

CompositionSummary.Builder destinations(Collection<DestinationSummary> destinations)

Array of Destination objects.

Parameters:

destinations - Array of Destination objects.

Returns:

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

destinations

CompositionSummary.Builder destinations(DestinationSummary... destinations)

Array of Destination objects.

Parameters:

destinations - Array of Destination objects.

Returns:

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

destinations

CompositionSummary.Builder destinations(Consumer<DestinationSummary.Builder>... destinations)

Array of Destination objects.

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

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

Parameters:

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

Returns:

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

See Also:

#destinations(java.util.Collection)

state

CompositionSummary.Builder state(String state)

State of the Composition resource.

Parameters:

state - State of the Composition resource.

Returns:

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

See Also:

CompositionState, CompositionState

state

CompositionSummary.Builder state(CompositionState state)

State of the Composition resource.

Parameters:

state - State of the Composition resource.

Returns:

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

See Also:

CompositionState, CompositionState

tags

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

startTime

CompositionSummary.Builder startTime(Instant startTime)

UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

Parameters:

startTime - UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.

Returns:

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

endTime

CompositionSummary.Builder endTime(Instant endTime)

UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

Parameters:

endTime - UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.

Returns:

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