Interface Composition.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<Composition.Builder,Composition>,SdkBuilder<Composition.Builder,Composition>,SdkPojo
- Enclosing class:
- Composition
public static interface Composition.Builder extends SdkPojo, CopyableBuilder<Composition.Builder,Composition>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description Composition.Builderarn(String arn)ARN of the Composition resource.Composition.Builderdestinations(Collection<Destination> destinations)Array of Destination objects.Composition.Builderdestinations(Consumer<Destination.Builder>... destinations)Array of Destination objects.Composition.Builderdestinations(Destination... destinations)Array of Destination objects.Composition.BuilderendTime(Instant endTime)UTC time of the Composition end.default Composition.Builderlayout(Consumer<LayoutConfiguration.Builder> layout)Layout object to configure composition parameters.Composition.Builderlayout(LayoutConfiguration layout)Layout object to configure composition parameters.Composition.BuilderstageArn(String stageArn)ARN of the stage used as inputComposition.BuilderstartTime(Instant startTime)UTC time of the Composition start.Composition.Builderstate(String state)State of the Composition.Composition.Builderstate(CompositionState state)State of the Composition.Composition.Buildertags(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, sdkFields
-
-
-
-
Method Detail
-
arn
Composition.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.
-
destinations
Composition.Builder destinations(Collection<Destination> destinations)
Array of Destination objects. A Composition can contain either one destination (
channelors3) or two (onechanneland ones3).- Parameters:
destinations- Array of Destination objects. A Composition can contain either one destination (channelors3) or two (onechanneland ones3).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinations
Composition.Builder destinations(Destination... destinations)
Array of Destination objects. A Composition can contain either one destination (
channelors3) or two (onechanneland ones3).- Parameters:
destinations- Array of Destination objects. A Composition can contain either one destination (channelors3) or two (onechanneland ones3).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinations
Composition.Builder destinations(Consumer<Destination.Builder>... destinations)
Array of Destination objects. A Composition can contain either one destination (
This is a convenience method that creates an instance of thechannelors3) or two (onechanneland ones3).Destination.Builderavoiding the need to create one manually viaDestination.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#destinations(List.) - Parameters:
destinations- a consumer that will call methods onDestination.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#destinations(java.util.Collection)
-
endTime
Composition.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.
-
layout
Composition.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 Composition.Builder layout(Consumer<LayoutConfiguration.Builder> layout)
Layout object to configure composition parameters.
This is a convenience method that creates an instance of theLayoutConfiguration.Builderavoiding the need to create one manually viaLayoutConfiguration.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tolayout(LayoutConfiguration).- Parameters:
layout- a consumer that will call methods onLayoutConfiguration.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
layout(LayoutConfiguration)
-
stageArn
Composition.Builder stageArn(String stageArn)
ARN of the stage used as input
- Parameters:
stageArn- ARN of the stage used as input- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTime
Composition.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.
-
state
Composition.Builder state(String state)
State of the Composition.
- Parameters:
state- State of the Composition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompositionState,CompositionState
-
state
Composition.Builder state(CompositionState state)
State of the Composition.
- Parameters:
state- State of the Composition.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompositionState,CompositionState
-
tags
Composition.Builder tags(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.- Parameters:
tags- Tags attached to the resource. Array of maps, each of the formstring: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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-