Class Composition
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Composition.Builder,
Composition>
Object specifying a Composition resource.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
ARN of the Composition resource.static Composition.Builder
builder()
final List
<Destination> Array of Destination objects.final Instant
endTime()
UTC time of the Composition end.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Destinations property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final LayoutConfiguration
layout()
Layout object to configure composition parameters.static Class
<? extends Composition.Builder> final String
stageArn()
ARN of the stage used as inputfinal Instant
UTC time of the Composition start.final CompositionState
state()
State of the Composition.final String
State of the Composition.tags()
Tags attached to the resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
ARN of the Composition resource.
- Returns:
- ARN of the Composition resource.
-
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 theisEmpty()
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
Array of Destination objects. A Composition can contain either one destination (
channel
ors3
) or two (onechannel
and ones3
).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 objects. A Composition can contain either one destination (
channel
ors3
) or two (onechannel
and ones3
).
-
endTime
UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
- Returns:
- UTC time of the Composition end. This is an ISO 8601 timestamp; note that this is returned as a string.
-
layout
Layout object to configure composition parameters.
- Returns:
- Layout object to configure composition parameters.
-
stageArn
ARN of the stage used as input
- Returns:
- ARN of the stage used as input
-
startTime
UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
- Returns:
- UTC time of the Composition start. This is an ISO 8601 timestamp; note that this is returned as a string.
-
state
State of the Composition.
If the service returns an enum value that is not available in the current SDK version,
state
will returnCompositionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- State of the Composition.
- See Also:
-
stateAsString
State of the Composition.
If the service returns an enum value that is not available in the current SDK version,
state
will returnCompositionState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- State of the Composition.
- See Also:
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Composition.Builder,
Composition> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-