Class CompositionSummary

java.lang.Object
software.amazon.awssdk.services.ivsrealtime.model.CompositionSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CompositionSummary.Builder,CompositionSummary>
@Generated("software.amazon.awssdk:codegen") public final class CompositionSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CompositionSummary.Builder,CompositionSummary>

Summary information about a Composition.

See Also:

  • Method Details

    • arn

      public final String arn()

      ARN of the Composition resource.

      Returns:
      ARN of the Composition resource.

    • stageArn

      public final String stageArn()

      ARN of the attached stage.

      Returns:
      ARN of the attached stage.

    • 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<DestinationSummary> destinations()

      Array of Destination objects.

      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.

    • state

      public final CompositionState state()

      State of the Composition resource.

      If the service returns an enum value that is not available in the current SDK version, state will return CompositionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      State of the Composition resource.
      See Also:

    • stateAsString

      public final String stateAsString()

      State of the Composition resource.

      If the service returns an enum value that is not available in the current SDK version, state will return CompositionState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      State of the Composition resource.
      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 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.

    • startTime

      public final Instant 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.

    • endTime

      public final Instant 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.

    • toBuilder

      public CompositionSummary.Builder 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 interface ToCopyableBuilder<CompositionSummary.Builder,CompositionSummary>
      Returns:
      a builder for type T

    • builder

      public static CompositionSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CompositionSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.